rmwc
Version:
A thin React wrapper for Material Design (Web) Components
1,613 lines • 259 kB
JSON
{
"src/Base/utils/DocumentComponent.js": [
{
"description": "",
"displayName": "DocumentComponent",
"methods": []
}
],
"src/Button/index.js": [
{
"description": "An icon that goes inside of buttons. This is an instance of the Icon component.",
"displayName": "ButtonIcon",
"methods": []
},
{
"description": "The Button component.",
"displayName": "Button",
"methods": [],
"props": {
"dense": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make the Button dense.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"raised": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make the Button raised.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"unelevated": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make the button unelevated.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"outlined": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make the button outlined.",
"defaultValue": {
"value": "false",
"computed": false
}
}
}
}
],
"src/Card/index.js": [
{
"description": "A Card Component",
"displayName": "Card",
"methods": [],
"props": {
"outlined": {
"flowType": {
"name": "boolean"
},
"required": true,
"description": "Removes the shadow and displays a hairline outline instead"
}
}
},
{
"description": "Media area that displays a custom background-image with background-size: cover",
"displayName": "CardMedia",
"methods": [],
"props": {
"square": {
"flowType": {
"name": "boolean"
},
"required": true,
"description": "Automatically scales the media area’s height to equal its width"
},
"sixteenByNine": {
"flowType": {
"name": "boolean"
},
"required": true,
"description": "Automatically scales the media area’s height according to its width, maintaining a 16:9 aspect ratio"
}
}
},
{
"description": "An absolutely-positioned box the same size as the media area, for displaying a title or icon on top of the background-image",
"displayName": "CardMediaContent",
"methods": []
},
{
"description": "Row containing action buttons and/or icons",
"displayName": "CardActions",
"methods": [],
"props": {
"fullBleed": {
"flowType": {
"name": "boolean"
},
"required": true,
"description": "Removes the action area’s padding and causes its only child (an mdc-card__action element) to consume 100% of the action area’s width"
}
}
},
{
"description": "A group of action buttons, displayed on the left side of the card (in LTR), adjacent to CardActionIcons",
"displayName": "CardActionButtons",
"methods": []
},
{
"description": "A group of supplemental action icons, displayed on the right side of the card (in LTR), adjacent to CardActionButtons",
"displayName": "CardActionIcons",
"methods": []
},
{
"description": "A Card action Button. Will return a Button component by default.",
"displayName": "CardAction",
"methods": [],
"props": {
"icon": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "An action icon with no text. This is an instance of the Icon component."
},
"use": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "The use prop when using an icon."
},
"iconToggle": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "An toggleable action icon with no text. This is an instance of the IconToggle component."
},
"on": {
"flowType": {
"name": "Object"
},
"required": false,
"description": "The on prop when using an iconToggle."
},
"off": {
"flowType": {
"name": "Object"
},
"required": false,
"description": "The off prop when using an iconToggle."
}
}
}
],
"src/Checkbox/index.js": [
{
"description": "",
"displayName": "CheckboxRoot",
"methods": [
{
"name": "classNames",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": {
"name": "intersection",
"raw": "{\n /** A DOM ID for the toggle. */\n id?: string,\n /** Disables the control. */\n disabled?: boolean,\n /** Toggle the control on and off. */\n checked?: boolean | string,\n /** The value of the control. */\n value?: boolean | string | number,\n /** Make the control indeterminate */\n indeterminate?: boolean,\n /** A label for the control. */\n label?: string\n} & SimpleTagPropsT",
"elements": [
{
"name": "signature",
"type": "object",
"raw": "{\n /** A DOM ID for the toggle. */\n id?: string,\n /** Disables the control. */\n disabled?: boolean,\n /** Toggle the control on and off. */\n checked?: boolean | string,\n /** The value of the control. */\n value?: boolean | string | number,\n /** Make the control indeterminate */\n indeterminate?: boolean,\n /** A label for the control. */\n label?: string\n}",
"signature": {
"properties": [
{
"key": "id",
"value": {
"name": "string",
"required": false
}
},
{
"key": "disabled",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "checked",
"value": {
"name": "union",
"raw": "boolean | string",
"elements": [
{
"name": "boolean"
},
{
"name": "string"
}
],
"required": false
}
},
{
"key": "value",
"value": {
"name": "union",
"raw": "boolean | string | number",
"elements": [
{
"name": "boolean"
},
{
"name": "string"
},
{
"name": "number"
}
],
"required": false
}
},
{
"key": "indeterminate",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "label",
"value": {
"name": "string",
"required": false
}
}
]
}
},
{
"name": "SimpleTagPropsT"
}
],
"alias": "CheckboxPropsT"
}
}
],
"returns": null
}
]
},
{
"description": "",
"displayName": "CheckboxNativeControl",
"methods": [],
"props": {
"type": {
"defaultValue": {
"value": "'checkbox'",
"computed": false
},
"required": false
}
}
},
{
"description": "",
"displayName": "CheckboxBackground",
"methods": []
},
{
"description": "",
"displayName": "CheckboxCheckmark",
"methods": [],
"props": {
"viewBox": {
"defaultValue": {
"value": "'0 0 24 24'",
"computed": false
},
"required": false
}
}
},
{
"description": "",
"displayName": "CheckboxCheckmarkPath",
"methods": [],
"props": {
"fill": {
"defaultValue": {
"value": "'none'",
"computed": false
},
"required": false
},
"stroke": {
"defaultValue": {
"value": "'white'",
"computed": false
},
"required": false
},
"d": {
"defaultValue": {
"value": "'M1.73,12.91 8.1,19.28 22.79,4.59'",
"computed": false
},
"required": false
}
}
},
{
"description": "",
"displayName": "CheckboxMixedmark",
"methods": []
},
{
"description": "",
"displayName": "CheckboxLabel",
"methods": []
},
{
"description": "A Checkbox component",
"displayName": "Checkbox",
"methods": [
{
"name": "syncWithProps",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "nextProps",
"type": {
"name": "intersection",
"raw": "{\n /** A DOM ID for the toggle. */\n id?: string,\n /** Disables the control. */\n disabled?: boolean,\n /** Toggle the control on and off. */\n checked?: boolean | string,\n /** The value of the control. */\n value?: boolean | string | number,\n /** Make the control indeterminate */\n indeterminate?: boolean,\n /** A label for the control. */\n label?: string\n} & SimpleTagPropsT",
"elements": [
{
"name": "signature",
"type": "object",
"raw": "{\n /** A DOM ID for the toggle. */\n id?: string,\n /** Disables the control. */\n disabled?: boolean,\n /** Toggle the control on and off. */\n checked?: boolean | string,\n /** The value of the control. */\n value?: boolean | string | number,\n /** Make the control indeterminate */\n indeterminate?: boolean,\n /** A label for the control. */\n label?: string\n}",
"signature": {
"properties": [
{
"key": "id",
"value": {
"name": "string",
"required": false
}
},
{
"key": "disabled",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "checked",
"value": {
"name": "union",
"raw": "boolean | string",
"elements": [
{
"name": "boolean"
},
{
"name": "string"
}
],
"required": false
}
},
{
"key": "value",
"value": {
"name": "union",
"raw": "boolean | string | number",
"elements": [
{
"name": "boolean"
},
{
"name": "string"
},
{
"name": "number"
}
],
"required": false
}
},
{
"key": "indeterminate",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "label",
"value": {
"name": "string",
"required": false
}
}
]
}
},
{
"name": "SimpleTagPropsT"
}
],
"alias": "CheckboxPropsT"
}
}
],
"returns": null
}
],
"props": {
"id": {
"flowType": {
"name": "string"
},
"required": false,
"description": "A DOM ID for the toggle."
},
"disabled": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Disables the control."
},
"checked": {
"flowType": {
"name": "union",
"raw": "boolean | string",
"elements": [
{
"name": "boolean"
},
{
"name": "string"
}
]
},
"required": false,
"description": "Toggle the control on and off."
},
"value": {
"flowType": {
"name": "union",
"raw": "boolean | string | number",
"elements": [
{
"name": "boolean"
},
{
"name": "string"
},
{
"name": "number"
}
]
},
"required": false,
"description": "The value of the control."
},
"indeterminate": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make the control indeterminate"
},
"label": {
"flowType": {
"name": "string"
},
"required": false,
"description": "A label for the control."
}
}
}
],
"src/Chip/index.js": [
{
"description": "A chip component.",
"displayName": "ChipRoot",
"methods": [
{
"name": "classNames",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": {
"name": "intersection",
"raw": "{\n /** A custom event you can use from MCW. You can also just use onClick instead. */\n onInteraction?: (evt: Event) => mixed,\n /** A custom event for the trailing icon that you can use from MCW. You can also just use onClick instead. */\n onTrailingIconInteraction?: (evt: Event) => mixed,\n /** makes the Chip appear selected. */\n selected?: boolean\n} & SimpleTagPropsT",
"elements": [
{
"name": "signature",
"type": "object",
"raw": "{\n /** A custom event you can use from MCW. You can also just use onClick instead. */\n onInteraction?: (evt: Event) => mixed,\n /** A custom event for the trailing icon that you can use from MCW. You can also just use onClick instead. */\n onTrailingIconInteraction?: (evt: Event) => mixed,\n /** makes the Chip appear selected. */\n selected?: boolean\n}",
"signature": {
"properties": [
{
"key": "onInteraction",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: Event) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "Event"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
},
{
"key": "onTrailingIconInteraction",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: Event) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "Event"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
},
{
"key": "selected",
"value": {
"name": "boolean",
"required": false
}
}
]
}
},
{
"name": "SimpleTagPropsT"
}
],
"alias": "ChipPropsT"
}
}
],
"returns": null
}
]
},
{
"description": "",
"displayName": "Chip",
"methods": [
{
"name": "initialize",
"docblock": null,
"modifiers": [],
"params": [],
"returns": null
}
],
"props": {
"onInteraction": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: Event) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "Event"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "A custom event you can use from MCW. You can also just use onClick instead."
},
"onTrailingIconInteraction": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: Event) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "Event"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "A custom event for the trailing icon that you can use from MCW. You can also just use onClick instead."
},
"selected": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "makes the Chip appear selected."
}
}
},
{
"description": "A checkmark for chip selection and filtering.",
"displayName": "ChipCheckmark",
"methods": []
},
{
"description": "Text for a chip.",
"displayName": "ChipText",
"methods": []
},
{
"description": "Icons inside of a chip. This is an instance of the Icon component. To make the icons interactive, add props tabIndex=\"0\" and role=\"button\".",
"displayName": "ChipIconRoot",
"methods": [
{
"name": "classNames",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": {
"name": "intersection",
"raw": "{\n /** Make it a leading icon */\n leading?: boolean,\n /** Make it a trailing icon */\n trailing?: boolean\n} & SimpleTagPropsT &\n IconPropsT",
"elements": [
{
"name": "signature",
"type": "object",
"raw": "{\n /** Make it a leading icon */\n leading?: boolean,\n /** Make it a trailing icon */\n trailing?: boolean\n}",
"signature": {
"properties": [
{
"key": "leading",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "trailing",
"value": {
"name": "boolean",
"required": false
}
}
]
}
},
{
"name": "SimpleTagPropsT"
},
{
"name": "IconPropsT"
}
],
"alias": "ChipIconPropsT"
}
}
],
"returns": null
}
]
},
{
"description": "",
"displayName": "ChipIcon",
"methods": [],
"props": {
"leading": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make it a leading icon"
},
"trailing": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make it a trailing icon"
}
}
},
{
"description": "",
"displayName": "ChipSetRoot",
"methods": [
{
"name": "classNames",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": {
"name": "signature",
"type": "object",
"raw": "{\n /** Creates a choice chipset */\n choice?: boolean,\n /** Creates a filter chipset */\n filter?: boolean\n}",
"signature": {
"properties": [
{
"key": "choice",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "filter",
"value": {
"name": "boolean",
"required": false
}
}
]
},
"alias": "ChipSetPropsT"
}
}
],
"returns": null
}
]
},
{
"description": "A container for multiple Chip components.",
"displayName": "ChipSet",
"methods": [],
"props": {
"choice": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Creates a choice chipset"
},
"filter": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Creates a filter chipset"
}
}
},
{
"description": "A non-standard abbreviated way for rendering chips.",
"displayName": "SimpleChip",
"methods": [],
"props": {
"text": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Text for your Chip"
},
"leadingIcon": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Instance of an Icon Component"
},
"trailingIcon": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Instance of an Icon Component"
},
"checkmark": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Includes a checkmark for the selected state"
},
"children": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Additional children will be rendered in the text area"
}
}
}
],
"src/Dialog/index.js": [
{
"description": "",
"displayName": "DialogRoot",
"methods": [],
"props": {
"role": {
"defaultValue": {
"value": "'alertdialog'",
"computed": false
},
"required": false
}
}
},
{
"description": "The Dialog backdrop",
"displayName": "DialogBackdrop",
"methods": []
},
{
"description": "The Dialog surface",
"displayName": "DialogSurface",
"methods": []
},
{
"description": "The Dialog header",
"displayName": "DialogHeader",
"methods": []
},
{
"description": "The Dialog title",
"displayName": "DialogHeaderTitle",
"methods": []
},
{
"description": "The Dialog body",
"displayName": "DialogBody",
"methods": [],
"props": {
"scrollable": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make it scrollable."
}
}
},
{
"description": "The Dialog footer",
"displayName": "DialogFooter",
"methods": []
},
{
"description": "A Dialog footer button",
"displayName": "DialogFooterButton",
"methods": [],
"props": {
"accept": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make it an accept button."
},
"cancel": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make it a cancel button."
}
}
},
{
"description": "",
"displayName": "Dialog",
"methods": [
{
"name": "syncWithProps",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "nextProps",
"type": {
"name": "signature",
"type": "object",
"raw": "{\n /** Whether or not the Dialog is showing. */\n open: boolean,\n /** Callback for when the accept Button is pressed. */\n onAccept?: (evt: CustomEventT) => mixed,\n /** Callback for when the Dialog was closed without acceptance. */\n onCancel?: (evt: CustomEventT) => mixed,\n /** Callback for when the Dialog closes. */\n onClose?: (evt: CustomEventT) => mixed\n}",
"signature": {
"properties": [
{
"key": "open",
"value": {
"name": "boolean",
"required": true
}
},
{
"key": "onAccept",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
},
{
"key": "onCancel",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
},
{
"key": "onClose",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
}
]
},
"alias": "DialogPropsT"
}
}
],
"returns": null
}
],
"props": {
"open": {
"flowType": {
"name": "boolean"
},
"required": true,
"description": "Whether or not the Dialog is showing."
},
"onAccept": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback for when the accept Button is pressed."
},
"onCancel": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback for when the Dialog was closed without acceptance."
},
"onClose": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback for when the Dialog closes."
}
}
},
{
"description": "A non-standard SimpleDialog component for ease of use.",
"displayName": "SimpleDialog",
"methods": [],
"props": {
"title": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "A title for the default Dialog template.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"header": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Additional Dialog header content for the default Dialog template.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"body": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Body content for the default Dialog template, rendered before children.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"footer": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Additional footer content for the default Dialog template, rendered before any buttons.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"acceptLabel": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Creates an accept button for the default Dialog template with a given label. You can pass `null` to remove the button.",
"defaultValue": {
"value": "'Accept'",
"computed": false
}
},
"cancelLabel": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Creates an cancel button for the default Dialog with a given label. You can pass `null` to remove the button.",
"defaultValue": {
"value": "'Cancel'",
"computed": false
}
},
"children": {
"flowType": {
"name": "ReactNode",
"raw": "React.Node"
},
"required": false,
"description": "Any children will be rendered in the body of the default Dialog template.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"scrollable": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Allow the body to be scrollable",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"open": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Whether or not the Dialog is showing.",
"defaultValue": {
"value": "false",
"computed": false
}
},
"onAccept": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback for when the accept Button is pressed.",
"defaultValue": {
"value": "noop",
"computed": true
}
},
"onCancel": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback for when the Dialog was closed without acceptance.",
"defaultValue": {
"value": "noop",
"computed": true
}
},
"onClose": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback for when the Dialog closes.",
"defaultValue": {
"value": "noop",
"computed": true
}
}
}
}
],
"src/Drawer/index.js": [
{
"description": "",
"displayName": "DrawerHeaderRoot",
"methods": []
},
{
"description": "",
"displayName": "DrawerHeaderContent",
"methods": []
},
{
"description": "A Header for Drawers",
"displayName": "DrawerHeader",
"methods": []
},
{
"description": "If you are using fixed a Toolbar, this provides space for it.",
"displayName": "DrawerToolbarSpacer",
"methods": []
},
{
"description": "Content for Drawers. Please note this is an instance of mdc-list by default. You can change this to a a non list container by specifying the tag as 'div' or anything else.",
"displayName": "DrawerContent",
"methods": []
},
{
"description": "",
"displayName": "DrawerRoot",
"methods": [
{
"name": "classNames",
"docblock": null,
"modifiers": [],
"params": [
{
"name": "props",
"type": {
"name": "intersection",
"raw": "{\n /** Opens or closes the Drawer. */\n open: boolean,\n /** Callback that fires when the Drawer is closed. */\n onClose?: (evt: CustomEventT) => mixed,\n /** Callback that fires when the Drawer is opened. */\n onOpen?: (evt: CustomEventT) => mixed,\n /** Makes a permanent drawer. */\n permanent?: boolean,\n /** Makes a persistent drawer. */\n persistent?: boolean,\n /** Makes a temporary drawer. */\n temporary?: boolean\n} & SimpleTagPropsT",
"elements": [
{
"name": "signature",
"type": "object",
"raw": "{\n /** Opens or closes the Drawer. */\n open: boolean,\n /** Callback that fires when the Drawer is closed. */\n onClose?: (evt: CustomEventT) => mixed,\n /** Callback that fires when the Drawer is opened. */\n onOpen?: (evt: CustomEventT) => mixed,\n /** Makes a permanent drawer. */\n permanent?: boolean,\n /** Makes a persistent drawer. */\n persistent?: boolean,\n /** Makes a temporary drawer. */\n temporary?: boolean\n}",
"signature": {
"properties": [
{
"key": "open",
"value": {
"name": "boolean",
"required": true
}
},
{
"key": "onClose",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
},
{
"key": "onOpen",
"value": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
},
"required": false
}
},
{
"key": "permanent",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "persistent",
"value": {
"name": "boolean",
"required": false
}
},
{
"key": "temporary",
"value": {
"name": "boolean",
"required": false
}
}
]
}
},
{
"name": "SimpleTagPropsT"
}
],
"alias": "DrawerPropsT"
}
}
],
"returns": null
}
]
},
{
"description": "",
"displayName": "DrawerDrawer",
"methods": []
},
{
"description": "",
"displayName": "Drawer",
"methods": [],
"props": {
"open": {
"flowType": {
"name": "boolean"
},
"required": true,
"description": "Opens or closes the Drawer."
},
"onClose": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback that fires when the Drawer is closed."
},
"onOpen": {
"flowType": {
"name": "signature",
"type": "function",
"raw": "(evt: CustomEventT) => mixed",
"signature": {
"arguments": [
{
"name": "evt",
"type": {
"name": "CustomEventT"
}
}
],
"return": {
"name": "mixed"
}
}
},
"required": false,
"description": "Callback that fires when the Drawer is opened."
},
"permanent": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Makes a permanent drawer."
},
"persistent": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Makes a persistent drawer."
},
"temporary": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Makes a temporary drawer."
}
}
}
],
"src/Elevation/index.js": [
{
"description": "The Elevation Component",
"displayName": "Elevation",
"methods": [],
"props": {
"z": {
"flowType": {
"name": "union",
"raw": "number | string",
"elements": [
{
"name": "number"
},
{
"name": "string"
}
]
},
"required": true,
"description": "A number from 0 - 24 for different levels of elevation"
},
"transition": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Allows for smooth transitions between elevations when the z value changes."
}
}
}
],
"src/Fab/index.js": [
{
"description": "",
"displayName": "FabIcon",
"methods": []
},
{
"description": "A floating action button component",
"displayName": "Fab",
"methods": [],
"props": {
"mini": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Make the Fab smaller.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"exited": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "Animates the FAB out of view. When this class is removed, the FAB will return to view.",
"defaultValue": {
"value": "undefined",
"computed": true
}
},
"cssOnly": {
"flowType": {
"name": "boolean"
},
"required": false,
"description": "cssOnly Fab.",
"defaultValue": {
"value": "undefined",
"computed": true
}
}
}
}
],
"src/FloatingLabel/index.js": [
{
"description": "",
"displayName": "FloatingLabel",
"methods": []
}
],
"src/FormField/index.js": [
{
"description": "",
"displayName": "FormFieldRoot",
"methods": [
{
"name": "classNames",
"docblock": null,