init project
Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled

This commit is contained in:
how2ice
2025-12-12 14:26:25 +09:00
commit 005cf56baf
43188 changed files with 1079531 additions and 0 deletions

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './accordion-details.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/accordion-details',
false,
/\.\/accordion-details.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,76 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": {
"name": "shape",
"description": "{ content?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ content?: elementType, root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AccordionDetails",
"imports": [
"import AccordionDetails from '@mui/joy/AccordionDetails';",
"import { AccordionDetails } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAccordionDetails-root"
},
{
"name": "content",
"description": "The component that renders the content.",
"default": "'div'",
"class": "MuiAccordionDetails-content"
}
],
"classes": [
{
"key": "expanded",
"className": "Mui-expanded",
"description": "Class name applied to the root element when expanded.",
"isGlobal": true
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAccordionDetails",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AccordionDetails/AccordionDetails.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-accordion/\">Accordion</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './accordion-group.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/accordion-group',
false,
/\.\/accordion-group.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,155 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disableDivider": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"transition": {
"type": {
"name": "union",
"description": "{ expanded: string, initial: string }<br>&#124;&nbsp;string"
},
"default": "'0.2s ease'"
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AccordionGroup",
"imports": [
"import AccordionGroup from '@mui/joy/AccordionGroup';",
"import { AccordionGroup } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAccordionGroup-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAccordionGroup-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAccordionGroup-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAccordionGroup-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAccordionGroup-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAccordionGroup-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAccordionGroup-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiAccordionGroup-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiAccordionGroup-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiAccordionGroup-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAccordionGroup-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAccordionGroup-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAccordionGroup-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAccordionGroup-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAccordionGroup",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AccordionGroup/AccordionGroup.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-accordion/\">Accordion</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './accordion-summary.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/accordion-summary',
false,
/\.\/accordion-summary.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,92 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"indicator": { "type": { "name": "node" }, "default": "<KeyboardArrowDown />" },
"slotProps": {
"type": {
"name": "shape",
"description": "{ button?: func<br>&#124;&nbsp;object, indicator?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ button?: elementType, indicator?: elementType, root?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AccordionSummary",
"imports": [
"import AccordionSummary from '@mui/joy/AccordionSummary';",
"import { AccordionSummary } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAccordionSummary-root"
},
{
"name": "button",
"description": "The component that renders the button.",
"default": "'button'",
"class": "MuiAccordionSummary-button"
},
{
"name": "indicator",
"description": "The component that renders the indicator.",
"default": "'span'",
"class": "MuiAccordionSummary-indicator"
}
],
"classes": [
{
"key": "disabled",
"className": "Mui-disabled",
"description": "Class name applied when the accordion is disabled.",
"isGlobal": true
},
{
"key": "expanded",
"className": "Mui-expanded",
"description": "Class name applied when the accordion is expanded.",
"isGlobal": true
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAccordionSummary",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AccordionSummary/AccordionSummary.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-accordion/\">Accordion</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './accordion.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/accordion',
false,
/\.\/accordion.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,84 @@
{
"props": {
"accordionId": { "type": { "name": "string" } },
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"defaultExpanded": { "type": { "name": "bool" }, "default": "false" },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"expanded": { "type": { "name": "bool" } },
"onChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, expanded: boolean) => void",
"describedArgs": ["event", "expanded"]
}
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Accordion",
"imports": [
"import Accordion from '@mui/joy/Accordion';",
"import { Accordion } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAccordion-root"
}
],
"classes": [
{
"key": "disabled",
"className": "Mui-disabled",
"description": "Class name applied to the root element if `disabled` is true.",
"isGlobal": true
},
{
"key": "expanded",
"className": "Mui-expanded",
"description": "Class name applied to the root element if `expanded` is true.",
"isGlobal": true
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAccordion",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Accordion/Accordion.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-accordion/\">Accordion</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './alert.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/alert', false, /\.\/alert.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,165 @@
{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"endDecorator": { "type": { "name": "node" } },
"invertedColors": { "type": { "name": "bool" }, "default": "false" },
"role": { "type": { "name": "string" }, "default": "'alert'" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ endDecorator?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Alert",
"imports": ["import Alert from '@mui/joy/Alert';", "import { Alert } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAlert-root"
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'span'",
"class": "MuiAlert-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'span'",
"class": "MuiAlert-endDecorator"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAlert-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAlert-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAlert-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAlert-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAlert-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAlert-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiAlert-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiAlert-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiAlert-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAlert-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAlert-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAlert-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAlert-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAlert",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Alert/Alert.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-alert/\">Alert</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './aspect-ratio.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/aspect-ratio',
false,
/\.\/aspect-ratio.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,144 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"flex": { "type": { "name": "bool" }, "default": "false" },
"maxHeight": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"minHeight": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"objectFit": {
"type": {
"name": "enum",
"description": "'-moz-initial'<br>&#124;&nbsp;'contain'<br>&#124;&nbsp;'cover'<br>&#124;&nbsp;'fill'<br>&#124;&nbsp;'inherit'<br>&#124;&nbsp;'initial'<br>&#124;&nbsp;'none'<br>&#124;&nbsp;'revert-layer'<br>&#124;&nbsp;'revert'<br>&#124;&nbsp;'scale-down'<br>&#124;&nbsp;'unset'"
},
"default": "'cover'"
},
"ratio": {
"type": { "name": "union", "description": "number<br>&#124;&nbsp;string" },
"default": "'16 / 9'"
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ content?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ content?: elementType, root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AspectRatio",
"imports": [
"import AspectRatio from '@mui/joy/AspectRatio';",
"import { AspectRatio } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAspectRatio-root"
},
{
"name": "content",
"description": "The component that renders the content.",
"default": "'div'",
"class": "MuiAspectRatio-content"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAspectRatio-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAspectRatio-colorDanger",
"description": "Class name applied to the content element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAspectRatio-colorNeutral",
"description": "Class name applied to the content element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAspectRatio-colorPrimary",
"description": "Class name applied to the content element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAspectRatio-colorSuccess",
"description": "Class name applied to the content element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAspectRatio-colorWarning",
"description": "Class name applied to the content element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAspectRatio-variantOutlined",
"description": "Class name applied to the content element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAspectRatio-variantPlain",
"description": "Class name applied to the content element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAspectRatio-variantSoft",
"description": "Class name applied to the content element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAspectRatio-variantSolid",
"description": "Class name applied to the content element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAspectRatio",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AspectRatio/AspectRatio.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-aspect-ratio/\">Aspect Ratio</a></li>\n<li><a href=\"/joy-ui/react-skeleton/\">Skeleton</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './autocomplete-listbox.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/autocomplete-listbox',
false,
/\.\/autocomplete-listbox.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,143 @@
{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"size": {
"type": { "name": "enum", "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'" },
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'contained'<br>&#124;&nbsp;'light'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'text'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AutocompleteListbox",
"imports": [
"import AutocompleteListbox from '@mui/joy/AutocompleteListbox';",
"import { AutocompleteListbox } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'ul'",
"class": "MuiAutocompleteListbox-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAutocompleteListbox-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAutocompleteListbox-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAutocompleteListbox-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAutocompleteListbox-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAutocompleteListbox-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAutocompleteListbox-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiAutocompleteListbox-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiAutocompleteListbox-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiAutocompleteListbox-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAutocompleteListbox-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAutocompleteListbox-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAutocompleteListbox-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAutocompleteListbox-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAutocompleteListbox",
"forwardsRefTo": "HTMLUListElement",
"filename": "/packages/mui-joy/src/AutocompleteListbox/AutocompleteListbox.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-autocomplete/\">Autocomplete</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './autocomplete-option.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/autocomplete-option',
false,
/\.\/autocomplete-option.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,132 @@
{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'contained'<br>&#124;&nbsp;'light'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'text'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AutocompleteOption",
"imports": [
"import AutocompleteOption from '@mui/joy/AutocompleteOption';",
"import { AutocompleteOption } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'li'",
"class": "MuiAutocompleteOption-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAutocompleteOption-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAutocompleteOption-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAutocompleteOption-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAutocompleteOption-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAutocompleteOption-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAutocompleteOption-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "focused",
"className": "Mui-focused",
"description": "State class applied to the root element if focused.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the `component`'s `focusVisibleClassName` prop.",
"isGlobal": true
},
{
"key": "variantOutlined",
"className": "MuiAutocompleteOption-variantOutlined",
"description": "State class applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAutocompleteOption-variantPlain",
"description": "State class applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAutocompleteOption-variantSoft",
"description": "State class applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAutocompleteOption-variantSolid",
"description": "State class applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAutocompleteOption",
"forwardsRefTo": "HTMLLIElement",
"filename": "/packages/mui-joy/src/AutocompleteOption/AutocompleteOption.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-autocomplete/\">Autocomplete</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './autocomplete.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/autocomplete',
false,
/\.\/autocomplete.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,422 @@
{
"props": {
"options": { "type": { "name": "array" }, "required": true },
"aria-describedby": { "type": { "name": "string" } },
"aria-label": { "type": { "name": "string" } },
"aria-labelledby": { "type": { "name": "string" } },
"autoComplete": { "type": { "name": "bool" }, "default": "false" },
"autoFocus": { "type": { "name": "bool" } },
"autoHighlight": { "type": { "name": "bool" }, "default": "false" },
"autoSelect": { "type": { "name": "bool" }, "default": "false" },
"blurOnSelect": {
"type": {
"name": "union",
"description": "'mouse'<br>&#124;&nbsp;'touch'<br>&#124;&nbsp;bool"
},
"default": "false"
},
"clearIcon": { "type": { "name": "node" }, "default": "<ClearIcon fontSize=\"md\" />" },
"clearOnBlur": { "type": { "name": "bool" }, "default": "!props.freeSolo" },
"clearOnEscape": { "type": { "name": "bool" }, "default": "false" },
"clearText": { "type": { "name": "string" }, "default": "'Clear'" },
"closeText": { "type": { "name": "string" }, "default": "'Close'" },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"defaultValue": {
"type": { "name": "custom", "description": "any" },
"default": "props.multiple ? [] : null"
},
"disableClearable": { "type": { "name": "bool" }, "default": "false" },
"disableCloseOnSelect": { "type": { "name": "bool" }, "default": "false" },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"disabledItemsFocusable": { "type": { "name": "bool" }, "default": "false" },
"disableListWrap": { "type": { "name": "bool" }, "default": "false" },
"endDecorator": { "type": { "name": "node" } },
"error": { "type": { "name": "bool" }, "default": "false" },
"filterOptions": {
"type": { "name": "func" },
"default": "createFilterOptions()",
"signature": {
"type": "function(options: Array<Value>, state: object) => Array<Value>",
"describedArgs": ["options", "state"]
}
},
"filterSelectedOptions": { "type": { "name": "bool" }, "default": "false" },
"forcePopupIcon": {
"type": { "name": "union", "description": "'auto'<br>&#124;&nbsp;bool" },
"default": "'auto'"
},
"freeSolo": { "type": { "name": "bool" }, "default": "false" },
"getLimitTagsText": {
"type": { "name": "func" },
"default": "(more: string | number) => `+${more}`",
"signature": {
"type": "function(more: string | number) => ReactNode",
"describedArgs": ["more"]
}
},
"getOptionDisabled": {
"type": { "name": "func" },
"signature": { "type": "function(option: Value) => boolean", "describedArgs": ["option"] }
},
"getOptionKey": {
"type": { "name": "func" },
"signature": {
"type": "function(option: Value) => string | number",
"describedArgs": ["option"]
}
},
"getOptionLabel": {
"type": { "name": "func" },
"default": "(option) => option.label ?? option",
"signature": { "type": "function(option: Value) => string", "describedArgs": [] }
},
"groupBy": {
"type": { "name": "func" },
"signature": { "type": "function(options: Value) => string", "describedArgs": ["options"] }
},
"handleHomeEndKeys": { "type": { "name": "bool" }, "default": "!props.freeSolo" },
"id": { "type": { "name": "string" } },
"includeInputInList": { "type": { "name": "bool" }, "default": "false" },
"inputValue": { "type": { "name": "string" } },
"isOptionEqualToValue": {
"type": { "name": "func" },
"signature": {
"type": "function(option: Value, value: Value) => boolean",
"describedArgs": ["option", "value"]
}
},
"limitTags": { "type": { "name": "custom", "description": "integer" }, "default": "-1" },
"loading": { "type": { "name": "bool" }, "default": "false" },
"loadingText": { "type": { "name": "node" }, "default": "'Loading…'" },
"multiple": { "type": { "name": "bool" }, "default": "false" },
"name": { "type": { "name": "string" } },
"noOptionsText": { "type": { "name": "node" }, "default": "'No options'" },
"onChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, value: Value | Array<Value>, reason: string, details?: string) => void",
"describedArgs": ["event", "value", "reason"]
}
},
"onClose": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, reason: string) => void",
"describedArgs": ["event", "reason"]
}
},
"onHighlightChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, option: Value, reason: string) => void",
"describedArgs": ["event", "option", "reason"]
}
},
"onInputChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent, value: string, reason: string) => void",
"describedArgs": ["event", "value", "reason"]
}
},
"onOpen": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.SyntheticEvent) => void",
"describedArgs": ["event"]
}
},
"open": { "type": { "name": "bool" } },
"openOnFocus": { "type": { "name": "bool" }, "default": "false" },
"openText": { "type": { "name": "string" }, "default": "'Open'" },
"placeholder": { "type": { "name": "string" } },
"popupIcon": { "type": { "name": "node" }, "default": "<ArrowDropDownIcon />" },
"readOnly": { "type": { "name": "bool" }, "default": "false" },
"renderGroup": {
"type": { "name": "func" },
"signature": {
"type": "function(params: AutocompleteRenderGroupParams) => ReactNode",
"describedArgs": ["params"]
}
},
"renderOption": {
"type": { "name": "func" },
"signature": {
"type": "function(props: object, option: T, state: object) => ReactNode",
"describedArgs": ["props", "option", "state"]
}
},
"renderTags": {
"type": { "name": "func" },
"signature": {
"type": "function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode",
"describedArgs": ["value", "getTagProps", "ownerState"]
}
},
"required": { "type": { "name": "bool" } },
"selectOnFocus": { "type": { "name": "bool" }, "default": "!props.freeSolo" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ clearIndicator?: func<br>&#124;&nbsp;object, endDecorator?: func<br>&#124;&nbsp;object, input?: func<br>&#124;&nbsp;object, limitTag?: func<br>&#124;&nbsp;object, listbox?: func<br>&#124;&nbsp;object, loading?: func<br>&#124;&nbsp;object, noOptions?: func<br>&#124;&nbsp;object, option?: func<br>&#124;&nbsp;object, popupIndicator?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object, wrapper?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ clearIndicator?: elementType, endDecorator?: elementType, input?: elementType, limitTag?: elementType, listbox?: elementType, loading?: elementType, noOptions?: elementType, option?: elementType, popupIndicator?: elementType, root?: elementType, startDecorator?: elementType, wrapper?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"type": { "type": { "name": "string" } },
"value": { "type": { "name": "custom", "description": "any" } },
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Autocomplete",
"imports": [
"import Autocomplete from '@mui/joy/Autocomplete';",
"import { Autocomplete } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAutocomplete-root"
},
{
"name": "wrapper",
"description": "The component that renders the wrapper.",
"default": "'div'",
"class": "MuiAutocomplete-wrapper"
},
{
"name": "input",
"description": "The component that renders the input.",
"default": "'input'",
"class": "MuiAutocomplete-input"
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'div'",
"class": "MuiAutocomplete-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'div'",
"class": "MuiAutocomplete-endDecorator"
},
{
"name": "clearIndicator",
"description": "The component that renders the clear indicator.",
"default": "'button'",
"class": "MuiAutocomplete-clearIndicator"
},
{
"name": "popupIndicator",
"description": "The component that renders the popup indicator.",
"default": "'button'",
"class": "MuiAutocomplete-popupIndicator"
},
{
"name": "listbox",
"description": "The component that renders the listbox.",
"default": "'ul'",
"class": "MuiAutocomplete-listbox"
},
{
"name": "option",
"description": "The component that renders the option.",
"default": "'li'",
"class": "MuiAutocomplete-option"
},
{
"name": "loading",
"description": "The component that renders the loading.",
"default": "'li'",
"class": "MuiAutocomplete-loading"
},
{
"name": "noOptions",
"description": "The component that renders the no-options.",
"default": "'li'",
"class": "MuiAutocomplete-noOptions"
},
{
"name": "limitTag",
"description": "The component that renders the limit tag.",
"default": "'div'",
"class": "MuiAutocomplete-limitTag"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAutocomplete-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAutocomplete-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAutocomplete-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAutocomplete-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAutocomplete-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAutocomplete-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "Class name applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "Mui-error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "focused",
"className": "Mui-focused",
"description": "Class name applied to the root element if the component is focused.",
"isGlobal": true
},
{
"key": "formControl",
"className": "MuiAutocomplete-formControl",
"description": "Class name applied to the root element if the component is a descendant of `FormControl`.",
"isGlobal": false
},
{
"key": "hasClearIcon",
"className": "MuiAutocomplete-hasClearIcon",
"description": "Class name applied when the clear icon is rendered.",
"isGlobal": false
},
{
"key": "hasPopupIcon",
"className": "MuiAutocomplete-hasPopupIcon",
"description": "Class name applied when the popup icon is rendered.",
"isGlobal": false
},
{
"key": "multiple",
"className": "MuiAutocomplete-multiple",
"description": "Class name applied to the wrapper element if `multiple={true}`.",
"isGlobal": false
},
{
"key": "popupIndicatorOpen",
"className": "MuiAutocomplete-popupIndicatorOpen",
"description": "Class name applied to the popup indicator if the popup is open.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiAutocomplete-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiAutocomplete-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiAutocomplete-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAutocomplete-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiAutocomplete-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAutocomplete-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAutocomplete-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAutocomplete",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Autocomplete/Autocomplete.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-autocomplete/\">Autocomplete</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './avatar-group.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/avatar-group',
false,
/\.\/avatar-group.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,68 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"size": {
"type": {
"name": "union",
"description": "'lg'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'sm'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "AvatarGroup",
"imports": [
"import AvatarGroup from '@mui/joy/AvatarGroup';",
"import { AvatarGroup } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAvatarGroup-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAvatarGroup",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/AvatarGroup/AvatarGroup.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-avatar/\">Avatar</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './avatar.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/avatar',
false,
/\.\/avatar.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,159 @@
{
"props": {
"alt": { "type": { "name": "string" } },
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"size": {
"type": {
"name": "union",
"description": "'lg'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'sm'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ fallback?: func<br>&#124;&nbsp;object, img?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ fallback?: elementType, img?: elementType, root?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"src": { "type": { "name": "string" } },
"srcSet": { "type": { "name": "string" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Avatar",
"imports": ["import Avatar from '@mui/joy/Avatar';", "import { Avatar } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiAvatar-root"
},
{
"name": "img",
"description": "The component that renders the img.",
"default": "'img'",
"class": "MuiAvatar-img"
},
{
"name": "fallback",
"description": "The component that renders the fallback.",
"default": "'svg'",
"class": "MuiAvatar-fallback"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiAvatar-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiAvatar-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiAvatar-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiAvatar-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiAvatar-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiAvatar-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiAvatar-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiAvatar-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiAvatar-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiAvatar-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiAvatar-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiAvatar-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyAvatar",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Avatar/Avatar.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-avatar/\">Avatar</a></li>\n<li><a href=\"/joy-ui/react-skeleton/\">Skeleton</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './badge.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/badge', false, /\.\/badge.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,210 @@
{
"props": {
"anchorOrigin": {
"type": {
"name": "shape",
"description": "{ horizontal: 'left'<br>&#124;&nbsp;'right', vertical: 'bottom'<br>&#124;&nbsp;'top' }"
},
"default": "{\n vertical: 'top',\n horizontal: 'right',\n}"
},
"badgeContent": { "type": { "name": "node" }, "default": "''" },
"badgeInset": {
"type": { "name": "union", "description": "number<br>&#124;&nbsp;string" },
"default": "0"
},
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'primary'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"invisible": { "type": { "name": "bool" }, "default": "false" },
"max": { "type": { "name": "number" }, "default": "99" },
"showZero": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ badge?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ badge?: elementType, root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'solid'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Badge",
"imports": ["import Badge from '@mui/joy/Badge';", "import { Badge } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiBadge-root"
},
{
"name": "badge",
"description": "The component that renders the badge.",
"default": "'span'",
"class": "MuiBadge-badge"
}
],
"classes": [
{
"key": "anchorOriginBottomLeft",
"className": "MuiBadge-anchorOriginBottomLeft",
"description": "Class name applied to the badge `span` element if `anchorOrigin={{ 'bottom', 'left' }}`.",
"isGlobal": false
},
{
"key": "anchorOriginBottomRight",
"className": "MuiBadge-anchorOriginBottomRight",
"description": "Class name applied to the badge `span` element if `anchorOrigin={{ 'bottom', 'right' }}`.",
"isGlobal": false
},
{
"key": "anchorOriginTopLeft",
"className": "MuiBadge-anchorOriginTopLeft",
"description": "Class name applied to the badge `span` element if `anchorOrigin={{ 'top', 'left' }}`.",
"isGlobal": false
},
{
"key": "anchorOriginTopRight",
"className": "MuiBadge-anchorOriginTopRight",
"description": "Class name applied to the badge `span` element if `anchorOrigin={{ 'top', 'right' }}`.",
"isGlobal": false
},
{
"key": "colorContext",
"className": "MuiBadge-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiBadge-colorDanger",
"description": "Class name applied to the badge `span` element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiBadge-colorNeutral",
"description": "Class name applied to the badge `span` element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiBadge-colorPrimary",
"description": "Class name applied to the badge `span` element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiBadge-colorSuccess",
"description": "Class name applied to the badge `span` element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiBadge-colorWarning",
"description": "Class name applied to the badge `span` element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "invisible",
"className": "MuiBadge-invisible",
"description": "State class applied to the badge `span` element if `invisible={true}`.",
"isGlobal": false
},
{
"key": "locationInside",
"className": "MuiBadge-locationInside",
"description": "State class applied to the badge `span` element if `location=\"inside\"`.",
"isGlobal": false
},
{
"key": "locationOutside",
"className": "MuiBadge-locationOutside",
"description": "State class applied to the badge `span` element if `location=\"outside\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiBadge-sizeLg",
"description": "Class name applied to the badge `span` element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiBadge-sizeMd",
"description": "Class name applied to the badge `span` element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiBadge-sizeSm",
"description": "Class name applied to the badge `span` element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiBadge-variantOutlined",
"description": "Class name applied to the badge `span` element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiBadge-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiBadge-variantSoft",
"description": "Class name applied to the badge `span` element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiBadge-variantSolid",
"description": "Class name applied to the badge `span` element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyBadge",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/Badge/Badge.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-badge/\">Badge</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './box.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/box', false, /\.\/box.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,30 @@
{
"props": {
"component": { "type": { "name": "elementType" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "Box",
"imports": ["import Box from '@mui/joy/Box';", "import { Box } from '@mui/joy';"],
"classes": [
{
"key": "root",
"className": "MuiBox-root",
"description": "Class name applied to the root element.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": false,
"muiName": "JoyBox",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Box/Box.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-box/\">Box</a></li></ul>",
"cssComponent": true
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './breadcrumbs.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/breadcrumbs',
false,
/\.\/breadcrumbs.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,96 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"separator": { "type": { "name": "node" }, "default": "'/'" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ li?: func<br>&#124;&nbsp;object, ol?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, separator?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ li?: elementType, ol?: elementType, root?: elementType, separator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "Breadcrumbs",
"imports": [
"import Breadcrumbs from '@mui/joy/Breadcrumbs';",
"import { Breadcrumbs } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'nav'",
"class": "MuiBreadcrumbs-root"
},
{
"name": "ol",
"description": "The component that renders the ol.",
"default": "'ol'",
"class": "MuiBreadcrumbs-ol"
},
{
"name": "li",
"description": "The component that renders the li.",
"default": "'li'",
"class": "MuiBreadcrumbs-li"
},
{
"name": "separator",
"description": "The component that renders the separator.",
"default": "'li'",
"class": "MuiBreadcrumbs-separator"
}
],
"classes": [
{
"key": "sizeLg",
"className": "MuiBreadcrumbs-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiBreadcrumbs-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiBreadcrumbs-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyBreadcrumbs",
"forwardsRefTo": "HTMLElement",
"filename": "/packages/mui-joy/src/Breadcrumbs/Breadcrumbs.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-breadcrumbs/\">Breadcrumbs</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './button-group.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/button-group',
false,
/\.\/button-group.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,172 @@
{
"props": {
"buttonFlex": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'horizontal'"
},
"size": {
"type": {
"name": "union",
"description": "'lg'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'sm'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"spacing": {
"type": {
"name": "union",
"description": "Array&lt;number<br>&#124;&nbsp;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;{ lg?: number<br>&#124;&nbsp;string, md?: number<br>&#124;&nbsp;string, sm?: number<br>&#124;&nbsp;string, xl?: number<br>&#124;&nbsp;string, xs?: number<br>&#124;&nbsp;string }<br>&#124;&nbsp;string"
},
"default": "0"
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "ButtonGroup",
"imports": [
"import ButtonGroup from '@mui/joy/ButtonGroup';",
"import { ButtonGroup } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiButtonGroup-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiButtonGroup-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiButtonGroup-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiButtonGroup-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiButtonGroup-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiButtonGroup-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiButtonGroup-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "horizontal",
"className": "MuiButtonGroup-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiButtonGroup-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiButtonGroup-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiButtonGroup-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiButtonGroup-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiButtonGroup-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiButtonGroup-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiButtonGroup-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiButtonGroup-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyButtonGroup",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/ButtonGroup/ButtonGroup.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-button-group/\">Button Group</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './button.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/button',
false,
/\.\/button.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,210 @@
{
"props": {
"action": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
}
},
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'primary'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"endDecorator": { "type": { "name": "node" } },
"fullWidth": { "type": { "name": "bool" }, "default": "false" },
"loading": { "type": { "name": "bool" }, "default": "false" },
"loadingIndicator": { "type": { "name": "node" }, "default": "<CircularProgress />" },
"loadingPosition": {
"type": {
"name": "enum",
"description": "'center'<br>&#124;&nbsp;'end'<br>&#124;&nbsp;'start'"
},
"default": "'center'"
},
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ endDecorator?: func<br>&#124;&nbsp;object, loadingIndicatorCenter?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ endDecorator?: elementType, loadingIndicatorCenter?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'solid'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Button",
"imports": ["import Button from '@mui/joy/Button';", "import { Button } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'button'",
"class": "MuiButton-root"
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'span'",
"class": "MuiButton-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'span'",
"class": "MuiButton-endDecorator"
},
{
"name": "loadingIndicatorCenter",
"description": "The component that renders the loading indicator center.",
"default": "'span'",
"class": "MuiButton-loadingIndicatorCenter"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiButton-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiButton-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiButton-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiButton-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiButton-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiButton-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the ButtonBase root element if the button is keyboard focused.",
"isGlobal": true
},
{
"key": "fullWidth",
"className": "MuiButton-fullWidth",
"description": "Class name applied to the root element if `fullWidth={true}`.",
"isGlobal": false
},
{
"key": "loading",
"className": "MuiButton-loading",
"description": "Class name applied to the root element if `loading={true}`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiButton-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiButton-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiButton-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiButton-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiButton-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiButton-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiButton-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": true,
"muiName": "JoyButton",
"forwardsRefTo": "HTMLButtonElement",
"filename": "/packages/mui-joy/src/Button/Button.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-button/\">Button</a></li>\n<li><a href=\"/joy-ui/react-button-group/\">Button Group</a></li>\n<li><a href=\"/joy-ui/react-toggle-button-group/\">Toggle Button Group</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './card-actions.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/card-actions',
false,
/\.\/card-actions.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,52 @@
{
"props": {
"buttonFlex": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"orientation": {
"type": {
"name": "enum",
"description": "'horizontal-reverse'<br>&#124;&nbsp;'horizontal'<br>&#124;&nbsp;'vertical'"
},
"default": "'horizontal'"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "CardActions",
"imports": [
"import CardActions from '@mui/joy/CardActions';",
"import { CardActions } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiCardActions-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCardActions",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/CardActions/CardActions.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-card/\">Card</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './card-content.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/card-content',
false,
/\.\/card-content.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,48 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'vertical'"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "CardContent",
"imports": [
"import CardContent from '@mui/joy/CardContent';",
"import { CardContent } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiCardContent-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCardContent",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/CardContent/CardContent.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-card/\">Card</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './card-cover.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/card-cover',
false,
/\.\/card-cover.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,44 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "CardCover",
"imports": [
"import CardCover from '@mui/joy/CardCover';",
"import { CardCover } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiCardCover-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCardCover",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/CardCover/CardCover.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-card/\">Card</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './card-overflow.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/card-overflow',
false,
/\.\/card-overflow.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,121 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "CardOverflow",
"imports": [
"import CardOverflow from '@mui/joy/CardOverflow';",
"import { CardOverflow } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiCardOverflow-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiCardOverflow-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiCardOverflow-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiCardOverflow-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiCardOverflow-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiCardOverflow-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiCardOverflow-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiCardOverflow-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiCardOverflow-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiCardOverflow-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiCardOverflow-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCardOverflow",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/CardOverflow/CardOverflow.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-card/\">Card</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './card.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/card', false, /\.\/card.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,161 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"invertedColors": { "type": { "name": "bool" }, "default": "false" },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'vertical'"
},
"size": {
"type": {
"name": "union",
"description": "'lg'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'sm'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Card",
"imports": ["import Card from '@mui/joy/Card';", "import { Card } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiCard-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiCard-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiCard-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiCard-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiCard-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiCard-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiCard-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "horizontal",
"className": "MuiCard-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiCard-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiCard-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiCard-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiCard-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiCard-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiCard-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiCard-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiCard-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCard",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Card/Card.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-card/\">Card</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './checkbox.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/checkbox',
false,
/\.\/checkbox.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,215 @@
{
"props": {
"checked": { "type": { "name": "bool" } },
"checkedIcon": { "type": { "name": "node" }, "default": "<CheckIcon />" },
"className": { "type": { "name": "string" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"defaultChecked": { "type": { "name": "bool" } },
"disabled": { "type": { "name": "bool" } },
"disableIcon": { "type": { "name": "bool" }, "default": "false" },
"indeterminate": { "type": { "name": "bool" }, "default": "false" },
"indeterminateIcon": { "type": { "name": "node" }, "default": "<IndeterminateIcon />" },
"label": { "type": { "name": "node" } },
"name": { "type": { "name": "string" } },
"onChange": {
"type": { "name": "func" },
"signature": {
"type": "function(event: React.ChangeEvent<HTMLInputElement>) => void",
"describedArgs": ["event"]
}
},
"overlay": { "type": { "name": "bool" }, "default": "false" },
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"size": {
"type": { "name": "enum", "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'" },
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ action?: func<br>&#124;&nbsp;object, checkbox?: func<br>&#124;&nbsp;object, input?: func<br>&#124;&nbsp;object, label?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ action?: elementType, checkbox?: elementType, input?: elementType, label?: elementType, root?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"uncheckedIcon": { "type": { "name": "node" } },
"value": {
"type": {
"name": "union",
"description": "Array&lt;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;string"
}
},
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'solid'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Checkbox",
"imports": ["import Checkbox from '@mui/joy/Checkbox';", "import { Checkbox } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiCheckbox-root"
},
{
"name": "checkbox",
"description": "The component that renders the checkbox.",
"default": "'span'",
"class": "MuiCheckbox-checkbox"
},
{
"name": "action",
"description": "The component that renders the action.",
"default": "'span'",
"class": "MuiCheckbox-action"
},
{
"name": "input",
"description": "The component that renders the input.",
"default": "'input'",
"class": "MuiCheckbox-input"
},
{
"name": "label",
"description": "The component that renders the label.",
"default": "'label'",
"class": "MuiCheckbox-label"
}
],
"classes": [
{
"key": "checked",
"className": "Mui-checked",
"description": "State class applied to the input component's `checked` class.",
"isGlobal": true
},
{
"key": "colorContext",
"className": "MuiCheckbox-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiCheckbox-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiCheckbox-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiCheckbox-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiCheckbox-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiCheckbox-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the input component's disabled class.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "Class name applied to the root element if the switch has visible focus",
"isGlobal": true
},
{
"key": "indeterminate",
"className": "MuiCheckbox-indeterminate",
"description": "State class applied to the root element if `indeterminate={true}`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiCheckbox-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiCheckbox-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiCheckbox-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiCheckbox-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiCheckbox-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiCheckbox-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": true,
"muiName": "JoyCheckbox",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/Checkbox/Checkbox.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-checkbox/\">Checkbox</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './chip-delete.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/chip-delete',
false,
/\.\/chip-delete.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,135 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" } },
"onDelete": { "type": { "name": "func" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "ChipDelete",
"imports": [
"import ChipDelete from '@mui/joy/ChipDelete';",
"import { ChipDelete } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'button'",
"class": "MuiChipDelete-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiChipDelete-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiChipDelete-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiChipDelete-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiChipDelete-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiChipDelete-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiChipDelete-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root element if keyboard focused.",
"isGlobal": true
},
{
"key": "variantOutlined",
"className": "MuiChipDelete-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiChipDelete-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiChipDelete-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiChipDelete-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyChipDelete",
"forwardsRefTo": "HTMLButtonElement",
"filename": "/packages/mui-joy/src/ChipDelete/ChipDelete.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-chip/\">Chip</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './chip.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/chip', false, /\.\/chip.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,208 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"endDecorator": { "type": { "name": "node" } },
"onClick": { "type": { "name": "func" } },
"size": {
"type": {
"name": "union",
"description": "'lg'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'sm'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ action?: func<br>&#124;&nbsp;object, endDecorator?: func<br>&#124;&nbsp;object, label?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ action?: elementType, endDecorator?: elementType, label?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Chip",
"imports": ["import Chip from '@mui/joy/Chip';", "import { Chip } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiChip-root"
},
{
"name": "label",
"description": "The component that renders the label.",
"default": "'span'",
"class": "MuiChip-label"
},
{
"name": "action",
"description": "The component that renders the action.",
"default": "'button'",
"class": null
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'span'",
"class": "MuiChip-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'span'",
"class": "MuiChip-endDecorator"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiChip-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiChip-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiChip-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiChip-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiChip-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiChip-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root element if keyboard focused.",
"isGlobal": true
},
{
"key": "labelLg",
"className": "MuiChip-labelLg",
"description": "Class name applied to the label `span` element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "labelMd",
"className": "MuiChip-labelMd",
"description": "Class name applied to the label `span` element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "labelSm",
"className": "MuiChip-labelSm",
"description": "Class name applied to the label `span` element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiChip-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiChip-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiChip-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiChip-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiChip-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiChip-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiChip-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyChip",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Chip/Chip.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-chip/\">Chip</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './circular-progress.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/circular-progress',
false,
/\.\/circular-progress.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,179 @@
{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'primary'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"determinate": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ progress?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, svg?: func<br>&#124;&nbsp;object, track?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ progress?: elementType, root?: elementType, svg?: elementType, track?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"thickness": { "type": { "name": "number" } },
"value": { "type": { "name": "number" }, "default": "determinate ? 0 : 25" },
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "CircularProgress",
"imports": [
"import CircularProgress from '@mui/joy/CircularProgress';",
"import { CircularProgress } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiCircularProgress-root"
},
{
"name": "svg",
"description": "The component that renders the svg.",
"default": "'svg'",
"class": "MuiCircularProgress-svg"
},
{
"name": "track",
"description": "The component that renders the track.",
"default": "'circle'",
"class": "MuiCircularProgress-track"
},
{
"name": "progress",
"description": "The component that renders the progress.",
"default": "'circle'",
"class": "MuiCircularProgress-progress"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiCircularProgress-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiCircularProgress-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiCircularProgress-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiCircularProgress-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiCircularProgress-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiCircularProgress-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "determinate",
"className": "MuiCircularProgress-determinate",
"description": "Class name applied to the root element if `determinate` is true.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiCircularProgress-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiCircularProgress-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiCircularProgress-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiCircularProgress-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiCircularProgress-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiCircularProgress-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiCircularProgress-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyCircularProgress",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/CircularProgress/CircularProgress.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-circular-progress/\">Circular Progress</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './css-baseline.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/css-baseline',
false,
/\.\/css-baseline.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,19 @@
{
"props": {
"children": { "type": { "name": "node" } },
"disableColorScheme": { "type": { "name": "bool" }, "default": "false" }
},
"name": "CssBaseline",
"imports": [
"import CssBaseline from '@mui/joy/CssBaseline';",
"import { CssBaseline } from '@mui/joy';"
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"muiName": "JoyCssBaseline",
"filename": "/packages/mui-joy/src/CssBaseline/CssBaseline.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-css-baseline/\">CSS Baseline</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './dialog-actions.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/dialog-actions',
false,
/\.\/dialog-actions.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,52 @@
{
"props": {
"buttonFlex": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"orientation": {
"type": {
"name": "enum",
"description": "'horizontal-reverse'<br>&#124;&nbsp;'horizontal'<br>&#124;&nbsp;'vertical'"
},
"default": "'horizontal-reverse'"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "DialogActions",
"imports": [
"import DialogActions from '@mui/joy/DialogActions';",
"import { DialogActions } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiDialogActions-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyDialogActions",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/DialogActions/DialogActions.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-modal/\">Modal</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './dialog-content.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/dialog-content',
false,
/\.\/dialog-content.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,48 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'vertical'"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "DialogContent",
"imports": [
"import DialogContent from '@mui/joy/DialogContent';",
"import { DialogContent } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiDialogContent-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyDialogContent",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/DialogContent/DialogContent.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-drawer/\">Drawer</a></li>\n<li><a href=\"/joy-ui/react-modal/\">Modal</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './dialog-title.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/dialog-title',
false,
/\.\/dialog-title.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,192 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"level": {
"type": {
"name": "enum",
"description": "'body-lg'<br>&#124;&nbsp;'body-md'<br>&#124;&nbsp;'body-sm'<br>&#124;&nbsp;'body-xs'<br>&#124;&nbsp;'h1'<br>&#124;&nbsp;'h2'<br>&#124;&nbsp;'h3'<br>&#124;&nbsp;'h4'<br>&#124;&nbsp;'inherit'<br>&#124;&nbsp;'title-lg'<br>&#124;&nbsp;'title-md'<br>&#124;&nbsp;'title-sm'"
},
"default": "{ sm: 'title-md', md: 'title-lg', lg: 'h4' }"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"additionalInfo": { "joy-variant": true }
}
},
"name": "DialogTitle",
"imports": [
"import DialogTitle from '@mui/joy/DialogTitle';",
"import { DialogTitle } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiDialogTitle-root"
}
],
"classes": [
{
"key": "body-lg",
"className": "MuiDialogTitle-body-lg",
"description": "Class name applied to the root element if `level=\"body-lg\"`.",
"isGlobal": false
},
{
"key": "body-md",
"className": "MuiDialogTitle-body-md",
"description": "Class name applied to the root element if `level=\"body-md\"`.",
"isGlobal": false
},
{
"key": "body-sm",
"className": "MuiDialogTitle-body-sm",
"description": "Class name applied to the root element if `level=\"body-sm\"`.",
"isGlobal": false
},
{
"key": "body-xs",
"className": "MuiDialogTitle-body-xs",
"description": "Class name applied to the root element if `level=\"body-xs\"`.",
"isGlobal": false
},
{
"key": "colorContext",
"className": "MuiDialogTitle-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiDialogTitle-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiDialogTitle-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiDialogTitle-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiDialogTitle-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiDialogTitle-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "h1",
"className": "MuiDialogTitle-h1",
"description": "Class name applied to the root element if `level=\"h1\"`.",
"isGlobal": false
},
{
"key": "h2",
"className": "MuiDialogTitle-h2",
"description": "Class name applied to the root element if `level=\"h2\"`.",
"isGlobal": false
},
{
"key": "h3",
"className": "MuiDialogTitle-h3",
"description": "Class name applied to the root element if `level=\"h3\"`.",
"isGlobal": false
},
{
"key": "h4",
"className": "MuiDialogTitle-h4",
"description": "Class name applied to the root element if `level=\"h4\"`.",
"isGlobal": false
},
{
"key": "title-lg",
"className": "MuiDialogTitle-title-lg",
"description": "Class name applied to the root element if `level=\"title-lg\"`.",
"isGlobal": false
},
{
"key": "title-md",
"className": "MuiDialogTitle-title-md",
"description": "Class name applied to the root element if `level=\"title-md\"`.",
"isGlobal": false
},
{
"key": "title-sm",
"className": "MuiDialogTitle-title-sm",
"description": "Class name applied to the root element if `level=\"title-sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiDialogTitle-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiDialogTitle-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiDialogTitle-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiDialogTitle-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyDialogTitle",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/DialogTitle/DialogTitle.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-modal/\">Modal</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './divider.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/divider',
false,
/\.\/divider.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,76 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"inset": {
"type": {
"name": "union",
"description": "'none'<br>&#124;&nbsp;'context'<br>&#124;&nbsp;string"
}
},
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'horizontal'"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "Divider",
"imports": ["import Divider from '@mui/joy/Divider';", "import { Divider } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'hr'",
"class": "MuiDivider-root"
}
],
"classes": [
{
"key": "horizontal",
"className": "MuiDivider-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "insetContext",
"className": "MuiDivider-insetContext",
"description": "Class name applied to the root element if `inset=\"context\"`.",
"isGlobal": false
},
{
"key": "insetNone",
"className": "MuiDivider-insetNone",
"description": "Class name applied to the root element if `inset=\"none\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiDivider-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyDivider",
"forwardsRefTo": "HTMLHRElement",
"filename": "/packages/mui-joy/src/Divider/Divider.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-divider/\">Divider</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './drawer.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/drawer',
false,
/\.\/drawer.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,181 @@
{
"props": {
"open": { "type": { "name": "bool" }, "required": true },
"anchor": {
"type": {
"name": "enum",
"description": "'bottom'<br>&#124;&nbsp;'left'<br>&#124;&nbsp;'right'<br>&#124;&nbsp;'top'"
},
"default": "'left'"
},
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"container": { "type": { "name": "union", "description": "HTML element<br>&#124;&nbsp;func" } },
"disableAutoFocus": { "type": { "name": "bool" }, "default": "false" },
"disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" },
"disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" },
"disablePortal": { "type": { "name": "bool" }, "default": "false" },
"disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" },
"disableScrollLock": { "type": { "name": "bool" }, "default": "false" },
"hideBackdrop": { "type": { "name": "bool" }, "default": "false" },
"invertedColors": { "type": { "name": "bool" }, "default": "false" },
"onClose": {
"type": { "name": "func" },
"signature": {
"type": "function(event: object, reason: string) => void",
"describedArgs": ["event", "reason"]
}
},
"size": {
"type": { "name": "enum", "description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'" },
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ backdrop?: func<br>&#124;&nbsp;object, content?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ backdrop?: elementType, content?: elementType, root?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"variant": {
"type": {
"name": "enum",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Drawer",
"imports": ["import Drawer from '@mui/joy/Drawer';", "import { Drawer } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiDrawer-root"
},
{
"name": "backdrop",
"description": "The component that renders the backdrop.",
"default": "'div'",
"class": "MuiDrawer-backdrop"
},
{
"name": "content",
"description": "The component that renders the content of the drawer.",
"default": "'div'",
"class": "MuiDrawer-content"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiDrawer-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiDrawer-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiDrawer-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiDrawer-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiDrawer-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiDrawer-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "hidden",
"className": "MuiDrawer-hidden",
"description": "Class name applied to the root element when open is false.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiDrawer-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiDrawer-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiDrawer-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiDrawer-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiDrawer-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiDrawer-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiDrawer-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": false,
"muiName": "JoyDrawer",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Drawer/Drawer.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-drawer/\">Drawer</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './form-control.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/form-control',
false,
/\.\/form-control.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,139 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"error": { "type": { "name": "bool" }, "default": "false" },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'vertical'"
},
"required": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "FormControl",
"imports": [
"import FormControl from '@mui/joy/FormControl';",
"import { FormControl } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiFormControl-root"
}
],
"classes": [
{
"key": "colorDanger",
"className": "MuiFormControl-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiFormControl-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiFormControl-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiFormControl-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiFormControl-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "Class name applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "Mui-error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "horizontal",
"className": "MuiFormControl-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiFormControl-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiFormControl-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiFormControl-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiFormControl-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyFormControl",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/FormControl/FormControl.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-input/\">Input</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './form-helper-text.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/form-helper-text',
false,
/\.\/form-helper-text.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,44 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "FormHelperText",
"imports": [
"import FormHelperText from '@mui/joy/FormHelperText';",
"import { FormHelperText } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'p'",
"class": "MuiFormHelperText-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyFormHelperText",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/FormHelperText/FormHelperText.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-input/\">Input</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './form-label.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/form-label',
false,
/\.\/form-label.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,54 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"required": { "type": { "name": "bool" } },
"slotProps": {
"type": {
"name": "shape",
"description": "{ asterisk?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ asterisk?: elementType, root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "FormLabel",
"imports": [
"import FormLabel from '@mui/joy/FormLabel';",
"import { FormLabel } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'label'",
"class": "MuiFormLabel-root"
},
{
"name": "asterisk",
"description": "The component that renders the asterisk.",
"default": "'span'",
"class": "MuiFormLabel-asterisk"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyFormLabel",
"forwardsRefTo": "HTMLLabelElement",
"filename": "/packages/mui-joy/src/FormLabel/FormLabel.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-input/\">Input</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './grid.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/grid', false, /\.\/grid.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,22 @@
{
"props": { "children": { "type": { "name": "node" } } },
"name": "Grid",
"imports": ["import Grid from '@mui/joy/Grid';", "import { Grid } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": null
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyGrid",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Grid/Grid.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-grid/\">Grid</a></li></ul>",
"cssComponent": true
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './icon-button.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/icon-button',
false,
/\.\/icon-button.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,186 @@
{
"props": {
"action": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
}
},
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"focusVisibleClassName": { "type": { "name": "string" } },
"loading": { "type": { "name": "bool" }, "default": "false" },
"loadingIndicator": { "type": { "name": "node" }, "default": "<CircularProgress />" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ loadingIndicator?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ loadingIndicator?: elementType, root?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "IconButton",
"imports": [
"import IconButton from '@mui/joy/IconButton';",
"import { IconButton } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'button'",
"class": "MuiIconButton-root"
},
{
"name": "loadingIndicator",
"description": "The component that renders the loading indicator.",
"default": "'span'",
"class": "MuiIconButton-loadingIndicator"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiIconButton-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiIconButton-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiIconButton-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiIconButton-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiIconButton-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiIconButton-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root element if the button is keyboard focused.",
"isGlobal": true
},
{
"key": "loading",
"className": "MuiIconButton-loading",
"description": "Class name applied to the root element if `loading={true}`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiIconButton-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiIconButton-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiIconButton-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiIconButton-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiIconButton-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiIconButton-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiIconButton-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": true,
"muiName": "JoyIconButton",
"forwardsRefTo": "HTMLButtonElement",
"filename": "/packages/mui-joy/src/IconButton/IconButton.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-button/\">Button</a></li>\n<li><a href=\"/joy-ui/react-button-group/\">Button Group</a></li>\n<li><a href=\"/joy-ui/react-toggle-button-group/\">Toggle Button Group</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './input.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/input', false, /\.\/input.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,186 @@
{
"props": {
"className": { "type": { "name": "string" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"endDecorator": { "type": { "name": "node" } },
"error": { "type": { "name": "bool" }, "default": "false" },
"fullWidth": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Input",
"imports": ["import Input from '@mui/joy/Input';", "import { Input } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiInput-root"
},
{
"name": "input",
"description": "The component that renders the input.",
"default": "'input'",
"class": "MuiInput-input"
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'div'",
"class": "MuiInput-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'div'",
"class": "MuiInput-endDecorator"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiInput-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiInput-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiInput-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiInput-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiInput-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiInput-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "Class name applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "Mui-error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "focused",
"className": "Mui-focused",
"description": "Class name applied to the root element if the component is focused.",
"isGlobal": true
},
{
"key": "formControl",
"className": "MuiInput-formControl",
"description": "Class name applied to the root element if the component is a descendant of `FormControl`.",
"isGlobal": false
},
{
"key": "fullWidth",
"className": "MuiInput-fullWidth",
"description": "Class name applied to the root element if `fullWidth={true}`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiInput-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiInput-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiInput-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiInput-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiInput-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiInput-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiInput-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": true,
"muiName": "JoyInput",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Input/Input.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-input/\">Input</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './linear-progress.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/linear-progress',
false,
/\.\/linear-progress.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,155 @@
{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'primary'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"determinate": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"thickness": { "type": { "name": "number" } },
"value": { "type": { "name": "number" }, "default": "determinate ? 0 : 25" },
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'soft'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "LinearProgress",
"imports": [
"import LinearProgress from '@mui/joy/LinearProgress';",
"import { LinearProgress } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiLinearProgress-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiLinearProgress-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiLinearProgress-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiLinearProgress-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiLinearProgress-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiLinearProgress-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiLinearProgress-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "determinate",
"className": "MuiLinearProgress-determinate",
"description": "Class name applied to the root element if `determinate` is true.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiLinearProgress-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiLinearProgress-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiLinearProgress-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiLinearProgress-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiLinearProgress-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiLinearProgress-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiLinearProgress-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyLinearProgress",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/LinearProgress/LinearProgress.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-linear-progress/\">Linear Progress</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './link.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/link', false, /\.\/link.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,251 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'primary'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"endDecorator": { "type": { "name": "node" } },
"level": {
"type": {
"name": "union",
"description": "'body1'<br>&#124;&nbsp;'body2'<br>&#124;&nbsp;'body3'<br>&#124;&nbsp;'h1'<br>&#124;&nbsp;'h2'<br>&#124;&nbsp;'h3'<br>&#124;&nbsp;'h4'<br>&#124;&nbsp;'h5'<br>&#124;&nbsp;'h6'<br>&#124;&nbsp;'inherit'<br>&#124;&nbsp;string"
},
"default": "'body-md'"
},
"overlay": { "type": { "name": "bool" }, "default": "false" },
"slotProps": {
"type": {
"name": "shape",
"description": "{ endDecorator?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"textColor": { "type": { "name": "any" } },
"underline": {
"type": {
"name": "enum",
"description": "'always'<br>&#124;&nbsp;'hover'<br>&#124;&nbsp;'none'"
},
"default": "'hover'"
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Link",
"imports": ["import Link from '@mui/joy/Link';", "import { Link } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'a'",
"class": "MuiLink-root"
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'span'",
"class": "MuiLink-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'span'",
"class": "MuiLink-endDecorator"
}
],
"classes": [
{
"key": "body-lg",
"className": "MuiLink-body-lg",
"description": "Class name applied to the root element if `level=\"body-lg\"`.",
"isGlobal": false
},
{
"key": "body-md",
"className": "MuiLink-body-md",
"description": "Class name applied to the root element if `level=\"body-md\"`.",
"isGlobal": false
},
{
"key": "body-sm",
"className": "MuiLink-body-sm",
"description": "Class name applied to the root element if `level=\"body-sm\"`.",
"isGlobal": false
},
{
"key": "body-xs",
"className": "MuiLink-body-xs",
"description": "Class name applied to the root element if `level=\"body-xs\"`.",
"isGlobal": false
},
{
"key": "colorContext",
"className": "MuiLink-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiLink-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiLink-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiLink-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiLink-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiLink-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the root element if the link is keyboard focused.",
"isGlobal": true
},
{
"key": "h1",
"className": "MuiLink-h1",
"description": "Class name applied to the root element if `level=\"h1\"`.",
"isGlobal": false
},
{
"key": "h2",
"className": "MuiLink-h2",
"description": "Class name applied to the root element if `level=\"h2\"`.",
"isGlobal": false
},
{
"key": "h3",
"className": "MuiLink-h3",
"description": "Class name applied to the root element if `level=\"h3\"`.",
"isGlobal": false
},
{
"key": "h4",
"className": "MuiLink-h4",
"description": "Class name applied to the root element if `level=\"h4\"`.",
"isGlobal": false
},
{
"key": "title-lg",
"className": "MuiLink-title-lg",
"description": "Class name applied to the root element if `level=\"title-lg\"`.",
"isGlobal": false
},
{
"key": "title-md",
"className": "MuiLink-title-md",
"description": "Class name applied to the root element if `level=\"title-md\"`.",
"isGlobal": false
},
{
"key": "title-sm",
"className": "MuiLink-title-sm",
"description": "Class name applied to the root element if `level=\"title-sm\"`.",
"isGlobal": false
},
{
"key": "underlineAlways",
"className": "MuiLink-underlineAlways",
"description": "Class name applied to the root element if `underline=\"always\"`.",
"isGlobal": false
},
{
"key": "underlineHover",
"className": "MuiLink-underlineHover",
"description": "Class name applied to the root element if `underline=\"hover\"`.",
"isGlobal": false
},
{
"key": "underlineNone",
"className": "MuiLink-underlineNone",
"description": "Class name applied to the root element if `underline=\"none\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiLink-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiLink-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiLink-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiLink-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyLink",
"forwardsRefTo": "HTMLAnchorElement",
"filename": "/packages/mui-joy/src/Link/Link.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-link/\">Link</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list-divider.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/list-divider',
false,
/\.\/list-divider.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,86 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"inset": {
"type": {
"name": "union",
"description": "'context'<br>&#124;&nbsp;'gutter'<br>&#124;&nbsp;'startDecorator'<br>&#124;&nbsp;'startContent'<br>&#124;&nbsp;string"
},
"default": "'context'"
},
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'horizontal'"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "ListDivider",
"imports": [
"import ListDivider from '@mui/joy/ListDivider';",
"import { ListDivider } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'li'",
"class": "MuiListDivider-root"
}
],
"classes": [
{
"key": "horizontal",
"className": "MuiListDivider-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "insetGutter",
"className": "MuiListDivider-insetGutter",
"description": "Class name applied to the root element if `inset=\"gutter\"`.",
"isGlobal": false
},
{
"key": "insetStartContent",
"className": "MuiListDivider-insetStartContent",
"description": "Class name applied to the root element if `inset=\"startContent\"`.",
"isGlobal": false
},
{
"key": "insetStartDecorator",
"className": "MuiListDivider-insetStartDecorator",
"description": "Class name applied to the root element if `inset=\"startDecorator\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiListDivider-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyListDivider",
"forwardsRefTo": "HTMLLIElement",
"filename": "/packages/mui-joy/src/ListDivider/ListDivider.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list-item-button.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/list-item-button',
false,
/\.\/list-item-button.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,165 @@
{
"props": {
"action": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
}
},
"autoFocus": { "type": { "name": "bool" }, "default": "false" },
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"focusVisibleClassName": { "type": { "name": "string" } },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'horizontal'"
},
"selected": { "type": { "name": "bool" }, "default": "false" },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "ListItemButton",
"imports": [
"import ListItemButton from '@mui/joy/ListItemButton';",
"import { ListItemButton } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiListItemButton-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiListItemButton-colorContext",
"description": "Class name applied to the root element if `color=\"context\"`.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiListItemButton-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiListItemButton-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiListItemButton-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiListItemButton-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiListItemButton-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the inner `component` element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the `component`'s `focusVisibleClassName` prop.",
"isGlobal": true
},
{
"key": "horizontal",
"className": "MuiListItemButton-horizontal",
"description": "Class name applied to the root element, if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "selected",
"className": "Mui-selected",
"description": "State class applied to the root element if `selected={true}`.",
"isGlobal": true
},
{
"key": "variantOutlined",
"className": "MuiListItemButton-variantOutlined",
"description": "State class applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiListItemButton-variantPlain",
"description": "State class applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiListItemButton-variantSoft",
"description": "State class applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiListItemButton-variantSolid",
"description": "State class applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiListItemButton-vertical",
"description": "Class name applied to the root element, if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyListItemButton",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/ListItemButton/ListItemButton.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list-item-content.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/list-item-content',
false,
/\.\/list-item-content.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,44 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "ListItemContent",
"imports": [
"import ListItemContent from '@mui/joy/ListItemContent';",
"import { ListItemContent } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiListItemContent-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyListItemContent",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/ListItemContent/ListItemContent.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list-item-decorator.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/list-item-decorator',
false,
/\.\/list-item-decorator.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,44 @@
{
"props": {
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
}
},
"name": "ListItemDecorator",
"imports": [
"import ListItemDecorator from '@mui/joy/ListItemDecorator';",
"import { ListItemDecorator } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiListItemDecorator-root"
}
],
"classes": [],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyListItemDecorator",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/ListItemDecorator/ListItemDecorator.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list-item.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/list-item',
false,
/\.\/list-item.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,158 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"endAction": { "type": { "name": "node" } },
"nested": { "type": { "name": "bool" }, "default": "false" },
"slotProps": {
"type": {
"name": "shape",
"description": "{ endAction?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startAction?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ endAction?: elementType, root?: elementType, startAction?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startAction": { "type": { "name": "node" } },
"sticky": { "type": { "name": "bool" }, "default": "false" },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "ListItem",
"imports": ["import ListItem from '@mui/joy/ListItem';", "import { ListItem } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'li'",
"class": "MuiListItem-root"
},
{
"name": "startAction",
"description": "The component that renders the start action.",
"default": "'div'",
"class": "MuiListItem-startAction"
},
{
"name": "endAction",
"description": "The component that renders the end action.",
"default": "'div'",
"class": "MuiListItem-endAction"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiListItem-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiListItem-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiListItem-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiListItem-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiListItem-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiListItem-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "nested",
"className": "MuiListItem-nested",
"description": "Class name applied to the root element, if nested={true}.",
"isGlobal": false
},
{
"key": "nesting",
"className": "MuiListItem-nesting",
"description": "Class name applied to the root element, if it is under a nested list item.",
"isGlobal": false
},
{
"key": "sticky",
"className": "MuiListItem-sticky",
"description": "Class name applied to the root element, if sticky={true}.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiListItem-variantOutlined",
"description": "State class applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiListItem-variantPlain",
"description": "State class applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiListItem-variantSoft",
"description": "State class applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiListItem-variantSolid",
"description": "State class applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyListItem",
"forwardsRefTo": "HTMLLIElement",
"filename": "/packages/mui-joy/src/ListItem/ListItem.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list-subheader.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/list-subheader',
false,
/\.\/list-subheader.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,126 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sticky": { "type": { "name": "bool" }, "default": "false" },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"additionalInfo": { "joy-variant": true }
}
},
"name": "ListSubheader",
"imports": [
"import ListSubheader from '@mui/joy/ListSubheader';",
"import { ListSubheader } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiListSubheader-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiListSubheader-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiListSubheader-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiListSubheader-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiListSubheader-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiListSubheader-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiListSubheader-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "sticky",
"className": "MuiListSubheader-sticky",
"description": "Class name applied to the root element, if sticky={true}.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiListSubheader-variantOutlined",
"description": "State class applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiListSubheader-variantPlain",
"description": "State class applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiListSubheader-variantSoft",
"description": "State class applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiListSubheader-variantSolid",
"description": "State class applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyListSubheader",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/ListSubheader/ListSubheader.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './list.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/list', false, /\.\/list.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,174 @@
{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"marker": { "type": { "name": "string" } },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'<br>&#124;&nbsp;'vertical'" },
"default": "'vertical'"
},
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'plain'",
"additionalInfo": { "joy-variant": true }
},
"wrap": { "type": { "name": "bool" }, "default": "false" }
},
"name": "List",
"imports": ["import List from '@mui/joy/List';", "import { List } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'ul'",
"class": "MuiList-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiList-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiList-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiList-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiList-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiList-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiList-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "horizontal",
"className": "MuiList-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "nesting",
"className": "MuiList-nesting",
"description": "Class name applied to the root element if wrapped with nested context.",
"isGlobal": false
},
{
"key": "scoped",
"className": "MuiList-scoped",
"description": "Class name applied to the root element if `scoped` is true.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiList-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiList-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiList-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiList-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiList-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiList-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiList-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiList-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyList",
"forwardsRefTo": "HTMLUListElement",
"filename": "/packages/mui-joy/src/List/List.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-list/\">Lists</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './menu-button.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/menu-button',
false,
/\.\/menu-button.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,207 @@
{
"props": {
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"endDecorator": { "type": { "name": "node" } },
"fullWidth": { "type": { "name": "bool" }, "default": "false" },
"loading": { "type": { "name": "bool" }, "default": "false" },
"loadingIndicator": { "type": { "name": "node" }, "default": "<CircularProgress />" },
"loadingPosition": {
"type": {
"name": "enum",
"description": "'center'<br>&#124;&nbsp;'end'<br>&#124;&nbsp;'start'"
},
"default": "'center'"
},
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ endDecorator?: func<br>&#124;&nbsp;object, loadingIndicatorCenter?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ endDecorator?: elementType, loadingIndicatorCenter?: elementType, root?: elementType, startDecorator?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"startDecorator": { "type": { "name": "node" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "MenuButton",
"imports": [
"import MenuButton from '@mui/joy/MenuButton';",
"import { MenuButton } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'button'",
"class": "MuiMenuButton-root"
},
{
"name": "startDecorator",
"description": "The component that renders the start decorator.",
"default": "'span'",
"class": "MuiMenuButton-startDecorator"
},
{
"name": "endDecorator",
"description": "The component that renders the end decorator.",
"default": "'span'",
"class": "MuiMenuButton-endDecorator"
},
{
"name": "loadingIndicatorCenter",
"description": "The component that renders the loading indicator center.",
"default": "'span'",
"class": "MuiMenuButton-loadingIndicatorCenter"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiMenuButton-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiMenuButton-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorInfo",
"className": "MuiMenuButton-colorInfo",
"description": "Class name applied to the root element if `color=\"info\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiMenuButton-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiMenuButton-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiMenuButton-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiMenuButton-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "fullWidth",
"className": "MuiMenuButton-fullWidth",
"description": "Class name applied to the root element if `fullWidth={true}`.",
"isGlobal": false
},
{
"key": "loading",
"className": "MuiMenuButton-loading",
"description": "Class name applied to the root element if `loading={true}`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiMenuButton-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiMenuButton-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiMenuButton-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiMenuButton-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiMenuButton-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiMenuButton-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiMenuButton-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyMenuButton",
"forwardsRefTo": "HTMLButtonElement",
"filename": "/packages/mui-joy/src/MenuButton/MenuButton.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-menu/\">Menu</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './menu-item.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/menu-item',
false,
/\.\/menu-item.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,101 @@
{
"props": { "children": { "type": { "name": "node" } } },
"name": "MenuItem",
"imports": ["import MenuItem from '@mui/joy/MenuItem';", "import { MenuItem } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiMenuItem-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiMenuItem-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiMenuItem-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiMenuItem-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiMenuItem-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiMenuItem-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiMenuItem-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "State class applied to the inner `component` element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "focusVisible",
"className": "Mui-focusVisible",
"description": "State class applied to the `component`'s `focusVisibleClassName` prop.",
"isGlobal": true
},
{
"key": "selected",
"className": "Mui-selected",
"description": "State class applied to the root element if `selected={true}`.",
"isGlobal": true
},
{
"key": "variantOutlined",
"className": "MuiMenuItem-variantOutlined",
"description": "State class applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiMenuItem-variantPlain",
"description": "State class applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiMenuItem-variantSoft",
"description": "State class applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiMenuItem-variantSolid",
"description": "State class applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": true,
"muiName": "JoyMenuItem",
"forwardsRefTo": "HTMLLIElement",
"filename": "/packages/mui-joy/src/MenuItem/MenuItem.tsx",
"inheritance": { "component": "ListItemButton", "pathname": "/joy-ui/api/list-item-button/" },
"demos": "<ul><li><a href=\"/joy-ui/react-menu/\">Menu</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,20 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './menu-list.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context(
'docs/translations/api-docs-joy/menu-list',
false,
/\.\/menu-list.*\.json$/,
);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,145 @@
{
"props": {
"actions": { "type": { "name": "custom", "description": "ref" } },
"color": {
"type": {
"name": "union",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"onItemsChange": { "type": { "name": "func" } },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "MenuList",
"imports": ["import MenuList from '@mui/joy/MenuList';", "import { MenuList } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'ul'",
"class": "MuiMenuList-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiMenuList-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiMenuList-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiMenuList-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiMenuList-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiMenuList-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiMenuList-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiMenuList-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiMenuList-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiMenuList-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiMenuList-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiMenuList-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiMenuList-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiMenuList-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyMenuList",
"forwardsRefTo": "HTMLUListElement",
"filename": "/packages/mui-joy/src/MenuList/MenuList.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-menu/\">Menu</a></li></ul>",
"cssComponent": false
}

View File

@@ -0,0 +1,16 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './menu.json';
export default function Page(props) {
const { descriptions } = props;
return <ApiPage descriptions={descriptions} pageContent={jsonPageContent} />;
}
export async function getStaticProps() {
const req = require.context('docs/translations/api-docs-joy/menu', false, /\.\/menu.*\.json$/);
const descriptions = mapApiPageTranslations(req);
return { props: { descriptions } };
}

View File

@@ -0,0 +1,168 @@
{
"props": {
"actions": { "type": { "name": "custom", "description": "ref" } },
"color": {
"type": {
"name": "enum",
"description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'neutral'",
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disablePortal": { "type": { "name": "bool" }, "default": "false" },
"invertedColors": { "type": { "name": "bool" }, "default": "false" },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"modifiers": {
"type": {
"name": "arrayOf",
"description": "Array&lt;{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'<br>&#124;&nbsp;'afterRead'<br>&#124;&nbsp;'afterWrite'<br>&#124;&nbsp;'beforeMain'<br>&#124;&nbsp;'beforeRead'<br>&#124;&nbsp;'beforeWrite'<br>&#124;&nbsp;'main'<br>&#124;&nbsp;'read'<br>&#124;&nbsp;'write', requires?: Array&lt;string&gt;, requiresIfExists?: Array&lt;string&gt; }&gt;"
}
},
"onClose": { "type": { "name": "func" } },
"onItemsChange": { "type": { "name": "func" } },
"open": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'<br>&#124;&nbsp;'md'<br>&#124;&nbsp;'lg'<br>&#124;&nbsp;string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"additionalInfo": { "sx": true }
},
"variant": {
"type": {
"name": "union",
"description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
},
"default": "'outlined'",
"additionalInfo": { "joy-variant": true }
}
},
"name": "Menu",
"imports": ["import Menu from '@mui/joy/Menu';", "import { Menu } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'ul'",
"class": "MuiMenu-root"
}
],
"classes": [
{
"key": "colorContext",
"className": "MuiMenu-colorContext",
"description": "Class name applied to the root element when color inversion is triggered.",
"isGlobal": false
},
{
"key": "colorDanger",
"className": "MuiMenu-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiMenu-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiMenu-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiMenu-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiMenu-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "expanded",
"className": "Mui-expanded",
"description": "Class name applied to the root element when the menu open.",
"isGlobal": true
},
{
"key": "listbox",
"className": "MuiMenu-listbox",
"description": "Class name applied to the listbox element.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiMenu-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiMenu-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiMenu-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "variantOutlined",
"className": "MuiMenu-variantOutlined",
"description": "Class name applied to the root element if `variant=\"outlined\"`.",
"isGlobal": false
},
{
"key": "variantPlain",
"className": "MuiMenu-variantPlain",
"description": "Class name applied to the root element if `variant=\"plain\"`.",
"isGlobal": false
},
{
"key": "variantSoft",
"className": "MuiMenu-variantSoft",
"description": "Class name applied to the root element if `variant=\"soft\"`.",
"isGlobal": false
},
{
"key": "variantSolid",
"className": "MuiMenu-variantSolid",
"description": "Class name applied to the root element if `variant=\"solid\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": false,
"muiName": "JoyMenu",
"forwardsRefTo": "HTMLUListElement",
"filename": "/packages/mui-joy/src/Menu/Menu.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-menu/\">Menu</a></li></ul>",
"cssComponent": false
}

Some files were not shown because too many files have changed in this diff Show More