[docs][joy] Build API documentations (#36008)

mui · Feb 21, 2023 · 17f9fc6 · 17f9fc6
1 parent d640c7e
commit 17f9fc6
Show file tree

Hide file tree

Showing 334 changed files with 5,636 additions and 174 deletions.
diff --git a/docs/data/joy/components/alert/alert.md b/docs/data/joy/components/alert/alert.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Alert component
+components: Alert
 githubLabel: 'component: alert'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/alert/
 ---

diff --git a/docs/data/joy/components/aspect-ratio/aspect-ratio-pt.md b/docs/data/joy/components/aspect-ratio/aspect-ratio-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Aspect Ratio component
+components: AspectRatio
 ---
 
 # Aspect ratio

diff --git a/docs/data/joy/components/aspect-ratio/aspect-ratio-zh.md b/docs/data/joy/components/aspect-ratio/aspect-ratio-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Aspect Ratio component
+components: AspectRatio
 ---
 
 # Aspect ratio

diff --git a/docs/data/joy/components/aspect-ratio/aspect-ratio.md b/docs/data/joy/components/aspect-ratio/aspect-ratio.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Aspect Ratio component
+components: AspectRatio
 ---
 
 # Aspect Ratio

diff --git a/docs/data/joy/components/autocomplete/autocomplete.md b/docs/data/joy/components/autocomplete/autocomplete.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Autocomplete component
+components: Autocomplete, AutocompleteListbox, AutocompleteOption
 githubLabel: 'component: autocomplete'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/
 ---

diff --git a/docs/data/joy/components/avatar/avatar-pt.md b/docs/data/joy/components/avatar/avatar-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Avatar component
+components: Avatar, AvatarGroup, SvgIcon
 githubLabel: 'component: avatar'
 ---
 

diff --git a/docs/data/joy/components/avatar/avatar-zh.md b/docs/data/joy/components/avatar/avatar-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Avatar component
+components: Avatar, AvatarGroup, SvgIcon
 githubLabel: 'component: avatar'
 ---
 

diff --git a/docs/data/joy/components/avatar/avatar.md b/docs/data/joy/components/avatar/avatar.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Avatar component
+components: Avatar, AvatarGroup, SvgIcon
 githubLabel: 'component: avatar'
 ---
 

diff --git a/docs/data/joy/components/badge/badge-pt.md b/docs/data/joy/components/badge/badge-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Badge component
+components: Badge
 githubLabel: 'component: badge'
 unstyled: /base/react-badge/
 ---

diff --git a/docs/data/joy/components/badge/badge-zh.md b/docs/data/joy/components/badge/badge-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Badge component
+components: Badge
 githubLabel: 'component: badge'
 unstyled: /base/react-badge/
 ---

diff --git a/docs/data/joy/components/badge/badge.md b/docs/data/joy/components/badge/badge.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Badge component
+components: Badge
 githubLabel: 'component: badge'
 unstyled: /base/react-badge/
 ---

diff --git a/docs/data/joy/components/breadcrumbs/breadcrumbs-pt.md b/docs/data/joy/components/breadcrumbs/breadcrumbs-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Breadcrumbs component
+components: Breadcrumbs
 ---
 
 # Breadcrumbs

diff --git a/docs/data/joy/components/breadcrumbs/breadcrumbs-zh.md b/docs/data/joy/components/breadcrumbs/breadcrumbs-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Breadcrumbs component
+components: Breadcrumbs
 ---
 
 # Breadcrumbs

diff --git a/docs/data/joy/components/breadcrumbs/breadcrumbs.md b/docs/data/joy/components/breadcrumbs/breadcrumbs.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Breadcrumbs component
+components: Breadcrumbs
 githubLabel: 'component: breadcrumbs'
 ---
 

diff --git a/docs/data/joy/components/button/button-pt.md b/docs/data/joy/components/button/button-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Button component
+components: Button, IconButton, LoadingButton
 githubLabel: 'component: button'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/
 unstyled: /base/react-button/

diff --git a/docs/data/joy/components/button/button-zh.md b/docs/data/joy/components/button/button-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Button component
+components: Button, IconButton, LoadingButton
 githubLabel: 'component: button'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/
 unstyled: /base/react-button/

diff --git a/docs/data/joy/components/button/button.md b/docs/data/joy/components/button/button.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Button component
+components: Button, IconButton, LoadingButton
 githubLabel: 'component: button'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/
 unstyled: /base/react-button/

diff --git a/docs/data/joy/components/card/card-pt.md b/docs/data/joy/components/card/card-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Card component
+components: Card, CardContent, CardCover, CardOverflow
 githubLabel: 'component: card'
 ---
 

diff --git a/docs/data/joy/components/card/card-zh.md b/docs/data/joy/components/card/card-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Card component
+components: Card, CardContent, CardCover, CardOverflow
 githubLabel: 'component: card'
 ---
 

diff --git a/docs/data/joy/components/card/card.md b/docs/data/joy/components/card/card.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Card component
+components: Card, CardContent, CardCover, CardOverflow
 githubLabel: 'component: card'
 ---
 

diff --git a/docs/data/joy/components/checkbox/checkbox-pt.md b/docs/data/joy/components/checkbox/checkbox-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Checkbox component
+components: Checkbox
 githubLabel: 'component: checkbox'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
 ---

diff --git a/docs/data/joy/components/checkbox/checkbox-zh.md b/docs/data/joy/components/checkbox/checkbox-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Checkbox component
+components: Checkbox
 githubLabel: 'component: checkbox'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
 ---

diff --git a/docs/data/joy/components/checkbox/checkbox.md b/docs/data/joy/components/checkbox/checkbox.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Checkbox component
+components: Checkbox
 githubLabel: 'component: checkbox'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
 ---

diff --git a/docs/data/joy/components/chip/chip-pt.md b/docs/data/joy/components/chip/chip-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Chip component
+components: Chip, ChipDelete
 githubLabel: 'component: chip'
 ---
 

diff --git a/docs/data/joy/components/chip/chip-zh.md b/docs/data/joy/components/chip/chip-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Chip component
+components: Chip, ChipDelete
 githubLabel: 'component: chip'
 ---
 

diff --git a/docs/data/joy/components/chip/chip.md b/docs/data/joy/components/chip/chip.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Chip component
+components: Chip, ChipDelete
 githubLabel: 'component: chip'
 ---
 

diff --git a/docs/data/joy/components/circular-progress/circular-progress.md b/docs/data/joy/components/circular-progress/circular-progress.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Circular Progress component
+components: CircularProgress
 githubLabel: 'component: CircularProgress'
 ---
 

diff --git a/docs/data/joy/components/css-baseline/css-baseline.md b/docs/data/joy/components/css-baseline/css-baseline.md
@@ -1,5 +1,6 @@
 ---
 product: joy-ui
+components: CssBaseline, ScopedCssBaseline
 githubLabel: 'component: CssBaseline'
 ---
 

diff --git a/docs/data/joy/components/divider/divider.md b/docs/data/joy/components/divider/divider.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Divider component
+components: Divider
 githubLabel: 'component: divider'
 ---
 

diff --git a/docs/data/joy/components/input/input.md b/docs/data/joy/components/input/input.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Input component
+components: FormControl, FormHelperText, FormLabel, Input
 unstyled: /base/react-input/
 ---
 

diff --git a/docs/data/joy/components/linear-progress/linear-progress.md b/docs/data/joy/components/linear-progress/linear-progress.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Linear Progress component
+components: LinearProgress
 githubLabel: 'component: LinearProgress'
 ---
 

diff --git a/docs/data/joy/components/link/link-pt.md b/docs/data/joy/components/link/link-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Link component
+components: Link
 githubLabel: 'component: link'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/link/
 ---

diff --git a/docs/data/joy/components/link/link-zh.md b/docs/data/joy/components/link/link-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Link component
+components: Link
 githubLabel: 'component: link'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/link/
 ---

diff --git a/docs/data/joy/components/link/link.md b/docs/data/joy/components/link/link.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Link component
+components: Link
 githubLabel: 'component: link'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/link/
 ---

diff --git a/docs/data/joy/components/list/list-pt.md b/docs/data/joy/components/list/list-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React List component
+components: List, ListDivider, ListItem, ListItemButton, ListItemContent, ListItemDecorator, ListSubheader
 githubLabel: 'component: list'
 ---
 

diff --git a/docs/data/joy/components/list/list-zh.md b/docs/data/joy/components/list/list-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React List component
+components: List, ListDivider, ListItem, ListItemButton, ListItemContent, ListItemDecorator, ListSubheader
 githubLabel: 'component: list'
 ---
 

diff --git a/docs/data/joy/components/list/list.md b/docs/data/joy/components/list/list.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React List component
+components: List, ListDivider, ListItem, ListItemButton, ListItemContent, ListItemDecorator, ListSubheader
 githubLabel: 'component: list'
 ---
 

diff --git a/docs/data/joy/components/menu/menu-pt.md b/docs/data/joy/components/menu/menu-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Menu component
+components: Menu, MenuItem, MenuList
 githubLabel: 'component: menu'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/
 unstyled: /base/react-menu/

diff --git a/docs/data/joy/components/menu/menu-zh.md b/docs/data/joy/components/menu/menu-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Menu component
+components: Menu, MenuItem, MenuList
 githubLabel: 'component: menu'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/
 unstyled: /base/react-menu/

diff --git a/docs/data/joy/components/menu/menu.md b/docs/data/joy/components/menu/menu.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Menu component
+components: Menu, MenuItem, MenuList
 githubLabel: 'component: menu'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/
 unstyled: /base/react-menu/

diff --git a/docs/data/joy/components/modal/modal.md b/docs/data/joy/components/modal/modal.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Modal component
+components: Modal, ModalClose, ModalDialog
 githubLabel: 'component: modal'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/
 ---

diff --git a/docs/data/joy/components/radio/radio-pt.md b/docs/data/joy/components/radio/radio-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Radio button component
+components: Radio, RadioGroup
 githubLabel: 'component: radio'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
 ---

diff --git a/docs/data/joy/components/radio/radio-zh.md b/docs/data/joy/components/radio/radio-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Radio button component
+components: Radio, RadioGroup
 githubLabel: 'component: radio'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
 ---

diff --git a/docs/data/joy/components/radio/radio.md b/docs/data/joy/components/radio/radio.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Radio Group component
+components: Radio, RadioGroup
 githubLabel: 'component: radio'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
 ---

diff --git a/docs/data/joy/components/select/select-pt.md b/docs/data/joy/components/select/select-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Select component
+components: Select, Option
 githubLabel: 'component: select'
 unstyled: /base/react-select/
 ---

diff --git a/docs/data/joy/components/select/select-zh.md b/docs/data/joy/components/select/select-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Select component
+components: Select, Option
 githubLabel: 'component: select'
 unstyled: /base/react-select/
 ---

diff --git a/docs/data/joy/components/select/select.md b/docs/data/joy/components/select/select.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Select component
+components: Select, Option
 githubLabel: 'component: select'
 waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/
 unstyled: /base/react-select/

diff --git a/docs/data/joy/components/sheet/sheet-pt.md b/docs/data/joy/components/sheet/sheet-pt.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Sheet component
+components: Sheet
 ---
 
 # Sheet

diff --git a/docs/data/joy/components/sheet/sheet-zh.md b/docs/data/joy/components/sheet/sheet-zh.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Sheet component
+components: Sheet
 ---
 
 # Sheet

diff --git a/docs/data/joy/components/sheet/sheet.md b/docs/data/joy/components/sheet/sheet.md
@@ -1,6 +1,7 @@
 ---
 product: joy-ui
 title: React Sheet component
+components: Sheet
 ---
 
 # Sheet