Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs][joy] List slots in API documentation #36271

Merged
merged 7 commits into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/pages/joy-ui/api/alert.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@
},
"name": "Alert",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "endDecorator",
"description": "The component used to render the end decorator.",
"default": "'span'",
"class": ".MuiAlert-endDecorator"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'div'",
"class": ".MuiAlert-root"
},
{
"name": "startDecorator",
"description": "The component used to render the start decorator.",
"default": "'span'",
"class": ".MuiAlert-startDecorator"
}
],
"spread": true,
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Alert/Alert.tsx",
Expand Down
14 changes: 14 additions & 0 deletions docs/pages/joy-ui/api/aspect-ratio.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@
},
"name": "AspectRatio",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "content",
"description": "The component used to render the content.",
"default": "'div'",
"class": ".MuiAspectRatio-content"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'div'",
"class": ".MuiAspectRatio-root"
}
],
"spread": true,
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AspectRatio/AspectRatio.tsx",
Expand Down
74 changes: 74 additions & 0 deletions docs/pages/joy-ui/api/autocomplete.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,80 @@
},
"name": "Autocomplete",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "clearIndicator",
"description": "The component used to render the clear indicator.",
"default": "'button'",
"class": ".MuiAutocomplete-clearIndicator"
},
{
"name": "endDecorator",
"description": "The component used to render the end decorator.",
"default": "'span'",
"class": ".MuiAutocomplete-endDecorator"
},
{
"name": "input",
"description": "The component used to render the input.",
"default": "'input'",
"class": ".MuiAutocomplete-input"
},
{
"name": "limitTag",
"description": "The component used to render the limit tag.",
"default": "'span'",
"class": ".MuiAutocomplete-limitTag"
},
{
"name": "listbox",
"description": "The component used to render the listbox.",
"default": "'ul'",
"class": ".MuiAutocomplete-listbox"
},
{
"name": "loading",
"description": "The component used to render the loading.",
"default": "'li'",
"class": ".MuiAutocomplete-loading"
},
{
"name": "noOptions",
"description": "The component used to render the no-options.",
"default": "'li'",
"class": ".MuiAutocomplete-noOptions"
},
{
"name": "option",
"description": "The component used to render the option.",
"default": "'li'",
"class": ".MuiAutocomplete-option"
},
{
"name": "popupIndicator",
"description": "The component used to render the popup indicator.",
"default": "'button'",
"class": ".MuiAutocomplete-popupIndicator"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'div'",
"class": ".MuiAutocomplete-root"
},
{
"name": "startDecorator",
"description": "The component used to render the start decorator.",
"default": "'span'",
"class": ".MuiAutocomplete-startDecorator"
},
{
"name": "wrapper",
"description": "The component used to render the wrapper.",
"default": "'div'",
"class": ".MuiAutocomplete-wrapper"
}
],
"spread": true,
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Autocomplete/Autocomplete.tsx",
Expand Down
20 changes: 20 additions & 0 deletions docs/pages/joy-ui/api/avatar.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,26 @@
},
"name": "Avatar",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "fallback",
"description": "The component used to render the fallback.",
"default": "'svg'",
"class": ".MuiAvatar-fallback"
},
{
"name": "img",
"description": "The component used to render the img.",
"default": "'img'",
"class": ".MuiAvatar-img"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'div'",
"class": ".MuiAvatar-root"
}
],
"spread": true,
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Avatar/Avatar.tsx",
Expand Down
14 changes: 14 additions & 0 deletions docs/pages/joy-ui/api/badge.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,20 @@
},
"name": "Badge",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "badge",
"description": "The component used to render the badge.",
"default": "'div'",
"class": ".MuiBadge-badge"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'div'",
"class": ".MuiBadge-root"
}
],
"spread": true,
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/Badge/Badge.tsx",
Expand Down
26 changes: 26 additions & 0 deletions docs/pages/joy-ui/api/breadcrumbs.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,32 @@
},
"name": "Breadcrumbs",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "li",
"description": "The component used to render the li.",
"default": "'li'",
"class": ".MuiBreadcrumbs-li"
},
{
"name": "ol",
"description": "The component used to render the ol.",
"default": "'ol'",
"class": ".MuiBreadcrumbs-ol"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'nav'",
"class": ".MuiBreadcrumbs-root"
},
{
"name": "separator",
"description": "The component used to render the separator.",
"default": "'li'",
"class": ".MuiBreadcrumbs-separator"
}
],
"spread": true,
"forwardsRefTo": "HTMLElement",
"filename": "/packages/mui-joy/src/Breadcrumbs/Breadcrumbs.tsx",
Expand Down
26 changes: 26 additions & 0 deletions docs/pages/joy-ui/api/button.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,32 @@
},
"name": "Button",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "endDecorator",
"description": "The component used to render the end decorator.",
"default": "'span'",
"class": ".MuiButton-endDecorator"
},
{
"name": "loadingIndicatorCenter",
"description": "The component used to render the loading indicator center.",
"default": "'span'",
"class": ".MuiButton-loadingIndicatorCenter"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'button'",
"class": ".MuiButton-root"
},
{
"name": "startDecorator",
"description": "The component used to render the start decorator.",
"default": "'span'",
"class": ".MuiButton-startDecorator"
}
],
"spread": false,
"forwardsRefTo": "HTMLButtonElement",
"filename": "/packages/mui-joy/src/Button/Button.tsx",
Expand Down
32 changes: 32 additions & 0 deletions docs/pages/joy-ui/api/checkbox.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,38 @@
},
"name": "Checkbox",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "action",
"description": "The component used to render the action.",
"default": "'span'",
"class": ".MuiCheckbox-action"
},
{
"name": "checkbox",
"description": "The component used to render the checkbox.",
"default": "'span'",
"class": ".MuiCheckbox-checkbox"
},
{
"name": "input",
"description": "The component used to render the input.",
"default": "'input'",
"class": ".MuiCheckbox-input"
},
{
"name": "label",
"description": "The component used to render the label.",
"default": "'label'",
"class": ".MuiCheckbox-label"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'span'",
"class": ".MuiCheckbox-root"
}
],
"spread": false,
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/Checkbox/Checkbox.tsx",
Expand Down
32 changes: 32 additions & 0 deletions docs/pages/joy-ui/api/chip.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,38 @@
},
"name": "Chip",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "action",
"description": "The component used to render the action.",
"default": "'button'",
"class": ".MuiChip-action"
},
{
"name": "endDecorator",
"description": "The component used to render the end decorator.",
"default": "'span'",
"class": ".MuiChip-endDecorator"
},
{
"name": "label",
"description": "The component used to render the label.",
"default": "'span'",
"class": ".MuiChip-label"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'div'",
"class": ".MuiChip-root"
},
{
"name": "startDecorator",
"description": "The component used to render the start decorator.",
"default": "'span'",
"class": ".MuiChip-startDecorator"
}
],
"spread": true,
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Chip/Chip.tsx",
Expand Down
26 changes: 26 additions & 0 deletions docs/pages/joy-ui/api/circular-progress.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,32 @@
},
"name": "CircularProgress",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "progress",
"description": "The component used to render the progress.",
"default": "'circle'",
"class": ".MuiCircularProgress-progress"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'span'",
"class": ".MuiCircularProgress-root"
},
{
"name": "svg",
"description": "The component used to render the svg.",
"default": "'svg'",
"class": ".MuiCircularProgress-svg"
},
{
"name": "track",
"description": "The component used to render the track.",
"default": "'circle'",
"class": ".MuiCircularProgress-track"
}
],
"spread": true,
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/CircularProgress/CircularProgress.tsx",
Expand Down
14 changes: 14 additions & 0 deletions docs/pages/joy-ui/api/form-label.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@
},
"name": "FormLabel",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"slots": [
{
"name": "asterisk",
"description": "The component used to render the asterisk.",
"default": "'span'",
"class": ".MuiFormLabel-asterisk"
},
{
"name": "root",
"description": "The component used to render the root.",
"default": "'label'",
"class": ".MuiFormLabel-root"
}
],
"spread": true,
"forwardsRefTo": "HTMLLabelElement",
"filename": "/packages/mui-joy/src/FormLabel/FormLabel.tsx",
Expand Down
Loading