From d4060c68f917184baab85c092daacca174ce38a6 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 2 Mar 2026 20:08:40 +0000 Subject: [PATCH 1/2] docs: complete Carousel and CarouselController documentation - Added component-level descriptions to Carousel.vue and CarouselController.vue. - Improved JSDoc for events and props in both components. - Corrected usage examples in docs/components/display/carousel.md and docs/components/containers/carousel-controller.md. - Regenerated docs/.docgen/components-metadata.json to include the new documentation. Co-authored-by: tassiocaique <7105035+tassiocaique@users.noreply.github.com> --- docs/.docgen/components-metadata.json | 10 +++++----- .../containers/carousel-controller.md | 3 ++- docs/components/display/carousel.md | 18 ++++++++++++------ src/components/Carousel.vue | 12 ++++++++---- src/components/CarouselController.vue | 4 ++++ 5 files changed, 31 insertions(+), 16 deletions(-) diff --git a/docs/.docgen/components-metadata.json b/docs/.docgen/components-metadata.json index fea21679..82639bf0 100644 --- a/docs/.docgen/components-metadata.json +++ b/docs/.docgen/components-metadata.json @@ -2122,10 +2122,10 @@ }, "CdsCarousel": { "name": "CdsCarousel", + "description": "O Carousel é um componente que permite a exibição de uma série de conteúdos\n(imagens, textos, cards, etc.) em um formato deslizante.", + "tags": {}, "exportName": "default", "displayName": "Carousel", - "description": "", - "tags": {}, "props": [ { "name": "items", @@ -2205,7 +2205,7 @@ "description": "Evento emitido quando algum item do carrossel é clicado.", "type": { "names": [ - "Event" + "any" ] } } @@ -2233,9 +2233,9 @@ }, "CdsCarouselController": { "displayName": "CdsCarouselController", - "exportName": "default", - "description": "", + "description": "CarouselControllers são componentes utilizados para controlar a exibição\nde elementos em carrosséis, informando a página atual ou o intervalo de itens sendo exibidos.", "tags": {}, + "exportName": "default", "props": [ { "name": "propertyName", diff --git a/docs/components/containers/carousel-controller.md b/docs/components/containers/carousel-controller.md index 8cc6d79e..c703e737 100644 --- a/docs/components/containers/carousel-controller.md +++ b/docs/components/containers/carousel-controller.md @@ -18,10 +18,11 @@ CarouselControllers são componentes utilizados para controlar a exibição de e ## Uso -```js +```html diff --git a/docs/components/display/carousel.md b/docs/components/display/carousel.md index 740f810a..abffdb3c 100644 --- a/docs/components/display/carousel.md +++ b/docs/components/display/carousel.md @@ -29,13 +29,19 @@ O Carousel é um componente que permite a exibição de uma série de conteúdos ## Uso -```js +```html + :items="items" + @item-click="handleItemClick" +> + + ``` --- diff --git a/src/components/Carousel.vue b/src/components/Carousel.vue index 33b39616..f7708f1d 100644 --- a/src/components/Carousel.vue +++ b/src/components/Carousel.vue @@ -61,6 +61,10 @@ import useIsMobile from '../utils/composables/useIsMobile'; import { ref, computed } from 'vue'; import Icon from './Icon.vue'; +/** + * O Carousel é um componente que permite a exibição de uma série de conteúdos + * (imagens, textos, cards, etc.) em um formato deslizante. + */ defineOptions({ name: 'CdsCarousel' }); const props = defineProps({ @@ -111,10 +115,10 @@ const props = defineProps({ const emit = defineEmits([ /** - * Evento emitido quando algum item do carrossel é clicado. - * @event item-click - * @type {Event} - */ + * Evento emitido quando algum item do carrossel é clicado. + * @event item-click + * @type {any} + */ 'item-click', ]); diff --git a/src/components/CarouselController.vue b/src/components/CarouselController.vue index 8305734a..d01612cb 100644 --- a/src/components/CarouselController.vue +++ b/src/components/CarouselController.vue @@ -41,6 +41,10 @@