diff --git a/lib/package.json b/lib/package.json index a9490fe33..467389991 100644 --- a/lib/package.json +++ b/lib/package.json @@ -2,7 +2,9 @@ "name": "welcome-ui", "version": "7.0.0", "description": "Customizable design system with react • styled-components • styled-system and ariakit.", - "files": ["dist"], + "files": [ + "dist" + ], "exports": { "./fonts/*": "./dist/fonts/*", "./theme": { @@ -93,7 +95,6 @@ "jest-environment-jsdom": "^29.7.0", "jest-styled-components": "7.2.0", "react": "^18.0.0", - "react-docgen-typescript": "^2.2.2", "rollup-preserve-directives": "^1.1.3", "styled-components": "^5.3.9", "typescript": "^5.6.3", diff --git a/lib/scripts/generate-types-doc.ts b/lib/scripts/generate-types-doc.ts deleted file mode 100644 index 28d17fc39..000000000 --- a/lib/scripts/generate-types-doc.ts +++ /dev/null @@ -1,158 +0,0 @@ -import { join, resolve } from 'path' -import fs, { existsSync } from 'fs' - -import docgen from 'react-docgen-typescript' - -const tsConfigPath = join(process.cwd(), 'tsconfig.json') - -const shouldDisplayPropsFiles = [ - 'lib/src/dist/types/utils/field-styles.d.ts', - 'lib/src/dist/types/components/Button/index.d.ts', - 'lib/src/dist/types/components/InputText/index.d.ts', - 'lib/node_modules/ariakit/ts/Tab/TabStore.d.ts', -] - -// Get only ComponentOptions declarations for prevent all WuiProps -const propFilter = (prop: docgen.PropItem) => { - if (prop.declarations?.length > 0) { - const isOptionDeclaration = prop.declarations.find(declaration => { - if (declaration.name.includes('Options')) return true - - return shouldDisplayPropsFiles.includes(declaration.fileName) - }) - - return Boolean(isOptionDeclaration) - } - - return true -} - -const { parse } = docgen.withCustomConfig(tsConfigPath, { - propFilter, - shouldRemoveUndefinedFromOptional: true, - shouldExtractValuesFromUnion: true, -}) - -const isComponentFile = (file: string) => { - if (file === 'index.tsx') { - return true - } - - const [name, extension] = file.split('.') - const firstLetter = name[0] - - // Components start with capital letter e.g. Title.js - if (extension === 'tsx' && firstLetter === firstLetter.toUpperCase()) { - return true - } - - return false -} - -// Get all files in a component folder -const getComponentFiles = async (folder: string) => { - const componentFiles = await fs.readdirSync(folder) - - return componentFiles.filter(isComponentFile) -} - -// Get definitions from file -const getFileDefinitions = (absolutePath: string) => { - const definitions = parse(absolutePath) - - return definitions -} - -// Write properties.json file -const writePropsFile = ( - file: string, - content: { - [name: string]: { props: Record; tag: string } - } -) => { - const withDocsPath = existsSync(join(file, 'docs')) - - if (withDocsPath) { - const destPath = join(file, 'docs', 'properties.json') - - fs.writeFileSync(destPath, JSON.stringify(content, null, 2)) - } - - return -} - -// check if props entries are empty -const arePropsEmpty = (obj: { - [name: string]: { props: Record; tag: string } -}) => { - // Helper function to check if an object is empty - const isEmptyObject = (obj: unknown) => { - return obj && typeof obj === 'object' && Object.keys(obj).length === 0 - } - - // Iterate through all keys in the object - // eslint-disable-next-line @typescript-eslint/no-unused-vars - return Object.entries(obj).every(([_, value]) => { - // If there's a props object, check if it's empty - if (value && typeof value === 'object' && 'props' in value) { - return isEmptyObject(value.props) - } - return true // If no props object, consider it valid - }) -} - -export async function generateTypesDoc() { - const parentDirectory = resolve(__dirname, '../') - const componentsDir = resolve(parentDirectory, 'src/components') - - // Read all directories in the components folder with a docs folder - const componentDirs = fs - .readdirSync(componentsDir, { withFileTypes: true }) - .filter(dirent => { - if (!dirent.isDirectory()) return false - // Check if the directory has a docs folder - try { - fs.accessSync(join(componentsDir, dirent.name, 'docs')) - return true - } catch { - return false - } - }) - .map(dirent => dirent.name) - - // Get all files in each component folder - componentDirs.map(async dirent => { - const files = await getComponentFiles(resolve(parentDirectory, 'src/components', dirent)) - - // Get definitions from each file - files.forEach(async file => { - const absolutePath = join(process.cwd(), 'src', 'components', dirent) - const definitions = getFileDefinitions(`${absolutePath}/${file}`) - const componentProps: { - [name: string]: { props: Record; tag: string } - } = {} - - definitions.forEach(definition => { - const { displayName, props, tags } = definition - const name = tags?.name || displayName - - if (props) { - componentProps[name] = { - tag: tags?.tag, - props: Object.keys(props) - .sort() - .reduce((obj: Record, key) => { - obj[key] = props[key] - return obj - }, {}), - } - } - }) - - // Write properties.json file check before if has no props - if (!arePropsEmpty(componentProps)) { - await writePropsFile(absolutePath, componentProps) - } - }) - }) -} diff --git a/lib/src/components/Accordion/docs/properties.json b/lib/src/components/Accordion/docs/properties.json deleted file mode 100644 index fb3fc1796..000000000 --- a/lib/src/components/Accordion/docs/properties.json +++ /dev/null @@ -1,199 +0,0 @@ -{ - "useAccordion": { - "props": { - "animated": { - "defaultValue": null, - "description": "Determines whether the content should animate when it is shown or hidden.\n- If `true`, the `animating` state will be `true` when the content is shown\n or hidden and it will wait for a CSS animation/transition to end before\n becoming `false`.\n- If it's set to a number, the `animating` state will be `true` when the\n content is shown or hidden and it will wait for the number of\n milliseconds to pass before becoming `false`.\n@deprecated Manually setting the `animated` prop is no longer necessary.\nThis will be removed in a future release.", - "name": "animated", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "number | boolean", - "value": [ - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "defaultOpen": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the content should be visible by default.", - "name": "defaultOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disclosure": { - "defaultValue": null, - "description": "A reference to another disclosure store that controls another disclosure\ncomponent to keep them in sync. Element states like `contentElement` and\n`disclosureElement` won't be synced. For that, use the\n[`store`](https://ariakit.org/reference/disclosure-provider#store) prop\ninstead.\n\nLive examples:\n- [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)", - "name": "disclosure", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "DisclosureStore" - } - }, - "setMounted": { - "defaultValue": null, - "description": "A callback that gets called when the `mounted` state changes.\n@example const [mounted, setMounted] = useState(false);\nconst disclosure = useDisclosureStore({ setMounted });", - "name": "setMounted", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(mounted: boolean) => void" - } - }, - "setOpen": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state\nchanges.\n@example const [open, setOpen] = useState(false);\nconst disclosure = useDisclosureStore({ open, setOpen });", - "name": "setOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(open: boolean) => void" - } - } - } - }, - "Accordion": { - "props": { - "icon": { - "defaultValue": { - "value": "" - }, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/Accordion/index.tsx", - "name": "AccordionOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Accordion/index.tsx", - "name": "AccordionOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "store": { - "defaultValue": null, - "description": "store from useAccordion()", - "name": "store", - "parent": { - "fileName": "lib/src/components/Accordion/index.tsx", - "name": "AccordionOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Accordion/index.tsx", - "name": "AccordionOptions" - } - ], - "required": true, - "type": { - "name": "DisclosureStore" - } - }, - "title": { - "defaultValue": null, - "description": "", - "name": "title", - "parent": { - "fileName": "lib/src/components/Accordion/index.tsx", - "name": "AccordionOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Accordion/index.tsx", - "name": "AccordionOptions" - } - ], - "required": true, - "type": { - "name": "enum", - "raw": "string | Element", - "value": [ - { - "value": "string" - }, - { - "value": "Element", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Alert/docs/properties.json b/lib/src/components/Alert/docs/properties.json deleted file mode 100644 index ce7784ed1..000000000 --- a/lib/src/components/Alert/docs/properties.json +++ /dev/null @@ -1,182 +0,0 @@ -{ - "Alert": { - "props": { - "closeButtonDataTestId": { - "defaultValue": null, - "description": "", - "name": "closeButtonDataTestId", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "cta": { - "defaultValue": null, - "description": "", - "name": "cta", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "handleClose": { - "defaultValue": null, - "description": "@description add a close button with an onclick handleClose function", - "name": "handleClose", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "isFullWidth": { - "defaultValue": null, - "description": "", - "name": "isFullWidth", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "size": { - "defaultValue": { - "value": "sm" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - } - ] - } - }, - "variant": { - "defaultValue": { - "value": "default" - }, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Alert/index.tsx", - "name": "AlertOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Variant", - "value": [ - { - "value": "\"danger\"" - }, - { - "value": "\"success\"" - }, - { - "value": "\"warning\"" - }, - { - "value": "\"info\"" - }, - { - "value": "\"default\"" - }, - { - "value": "\"beige\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/AspectRatio/docs/properties.json b/lib/src/components/AspectRatio/docs/properties.json deleted file mode 100644 index d1ab3fb82..000000000 --- a/lib/src/components/AspectRatio/docs/properties.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "AspectRatio": { - "props": { - "ratio": { - "defaultValue": { - "value": "4 / 3" - }, - "description": "", - "name": "ratio", - "parent": { - "fileName": "lib/src/components/AspectRatio/index.tsx", - "name": "AspectRatioOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/AspectRatio/index.tsx", - "name": "AspectRatioOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Avatar/docs/properties.json b/lib/src/components/Avatar/docs/properties.json deleted file mode 100644 index 69ffdaf16..000000000 --- a/lib/src/components/Avatar/docs/properties.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "Avatar": { - "props": { - "color": { - "defaultValue": null, - "description": "", - "name": "color", - "parent": { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - } - ], - "required": false, - "type": { - "name": "any" - } - }, - "getInitials": { - "defaultValue": null, - "description": "", - "name": "getInitials", - "parent": { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - } - ], - "required": false, - "type": { - "name": "(name: string) => string" - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - } - ], - "required": true, - "type": { - "name": "string" - } - }, - "shape": { - "defaultValue": null, - "description": "", - "name": "shape", - "parent": { - "fileName": "lib/src/components/Shape/index.tsx", - "name": "ShapeOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Shape/index.tsx", - "name": "ShapeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"circle\" | \"square\"", - "value": [ - { - "value": "\"circle\"" - }, - { - "value": "\"square\"" - } - ] - } - }, - "size": { - "defaultValue": null, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - }, - { - "value": "\"xl\"" - }, - { - "value": "\"xxl\"" - } - ] - } - }, - "src": { - "defaultValue": null, - "description": "", - "name": "src", - "parent": { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Avatar/index.tsx", - "name": "AvatarOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Badge/docs/properties.json b/lib/src/components/Badge/docs/properties.json deleted file mode 100644 index 03e5f7d29..000000000 --- a/lib/src/components/Badge/docs/properties.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "Badge": { - "props": {} - } -} \ No newline at end of file diff --git a/lib/src/components/Breadcrumb/docs/properties.json b/lib/src/components/Breadcrumb/docs/properties.json deleted file mode 100644 index bfabaaa3d..000000000 --- a/lib/src/components/Breadcrumb/docs/properties.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "Breadcrumb": { - "props": { - "gradientBackground": { - "defaultValue": { - "value": "neutral-10" - }, - "description": "color from theme, add for scroll gradient on mobile", - "name": "gradientBackground", - "parent": { - "fileName": "lib/src/components/Breadcrumb/index.tsx", - "name": "BreadcrumbOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Breadcrumb/index.tsx", - "name": "BreadcrumbOptions" - } - ], - "required": false, - "type": { - "name": "any" - } - }, - "lastChildNotClickable": { - "defaultValue": { - "value": true - }, - "description": "set clickable or not the last child", - "name": "lastChildNotClickable", - "parent": { - "fileName": "lib/src/components/Breadcrumb/index.tsx", - "name": "BreadcrumbOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Breadcrumb/index.tsx", - "name": "BreadcrumbOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "separator": { - "defaultValue": { - "value": "" - }, - "description": "", - "name": "separator", - "parent": { - "fileName": "lib/src/components/Breadcrumb/index.tsx", - "name": "BreadcrumbOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Breadcrumb/index.tsx", - "name": "BreadcrumbOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ReactNode", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "ReactElement>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ReactFragment", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ReactPortal", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Button/docs/properties.json b/lib/src/components/Button/docs/properties.json deleted file mode 100644 index 8ad18a80b..000000000 --- a/lib/src/components/Button/docs/properties.json +++ /dev/null @@ -1,194 +0,0 @@ -{ - "Button": { - "tag": "button", - "props": { - "danger": { - "defaultValue": null, - "description": "Danger button with 3 variants: primary / tertiary / ghost", - "name": "danger", - "parent": { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "isLoading": { - "defaultValue": null, - "description": "", - "name": "isLoading", - "parent": { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "shape": { - "defaultValue": null, - "description": "", - "name": "shape", - "parent": { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Shape", - "value": [ - { - "value": "\"circle\"" - }, - { - "value": "\"square\"" - } - ] - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - } - ] - } - }, - "variant": { - "defaultValue": { - "value": "primary" - }, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Button/index.tsx", - "name": "ButtonOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Variant", - "value": [ - { - "value": "\"disabled\"" - }, - { - "value": "\"primary\"" - }, - { - "value": "\"secondary\"" - }, - { - "value": "\"tertiary\"" - }, - { - "value": "\"ghost\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/ButtonGroup/docs/properties.json b/lib/src/components/ButtonGroup/docs/properties.json deleted file mode 100644 index bbf78109a..000000000 --- a/lib/src/components/ButtonGroup/docs/properties.json +++ /dev/null @@ -1,105 +0,0 @@ -{ - "ButtonGroup": { - "props": { - "disabled": { - "defaultValue": null, - "description": "Disable all your buttons components", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/ButtonGroup/index.tsx", - "name": "ButtonGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/ButtonGroup/index.tsx", - "name": "ButtonGroupOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "size": { - "defaultValue": null, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/ButtonGroup/index.tsx", - "name": "ButtonGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/ButtonGroup/index.tsx", - "name": "ButtonGroupOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - } - ] - } - }, - "variant": { - "defaultValue": null, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/ButtonGroup/index.tsx", - "name": "ButtonGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/ButtonGroup/index.tsx", - "name": "ButtonGroupOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Variant", - "value": [ - { - "value": "\"disabled\"" - }, - { - "value": "\"primary\"" - }, - { - "value": "\"secondary\"" - }, - { - "value": "\"tertiary\"" - }, - { - "value": "\"ghost\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Card/docs/properties.json b/lib/src/components/Card/docs/properties.json deleted file mode 100644 index eb488b0c0..000000000 --- a/lib/src/components/Card/docs/properties.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "Card.Cover": { - "props": { - "shape": { - "defaultValue": null, - "description": "", - "name": "shape", - "parent": { - "fileName": "lib/src/components/Shape/index.tsx", - "name": "ShapeOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Shape/index.tsx", - "name": "ShapeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"circle\" | \"square\"", - "value": [ - { - "value": "\"circle\"" - }, - { - "value": "\"square\"" - } - ] - } - }, - "src": { - "defaultValue": null, - "description": "", - "name": "src", - "parent": { - "fileName": "lib/src/components/Card/Cover.tsx", - "name": "CoverOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Card/Cover.tsx", - "name": "CoverOptions" - } - ], - "required": true, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Checkbox/docs/properties.json b/lib/src/components/Checkbox/docs/properties.json deleted file mode 100644 index f9de98acf..000000000 --- a/lib/src/components/Checkbox/docs/properties.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "Checkbox": { - "props": { - "Component": { - "defaultValue": { - "value": "S.Checkbox" - }, - "description": "", - "name": "Component", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ElementType", - "value": [ - { - "value": "\"symbol\"" - }, - { - "value": "\"object\"" - }, - { - "value": "\"a\"" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"area\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"audio\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"base\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"blockquote\"" - }, - { - "value": "\"body\"" - }, - { - "value": "\"br\"" - }, - { - "value": "\"button\"" - }, - { - "value": "\"canvas\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"col\"" - }, - { - "value": "\"colgroup\"" - }, - { - "value": "\"data\"" - }, - { - "value": "\"datalist\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"del\"" - }, - { - "value": "\"details\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"dialog\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dl\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"embed\"" - }, - { - "value": "\"fieldset\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"form\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"hr\"" - }, - { - "value": "\"html\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"iframe\"" - }, - { - "value": "\"img\"" - }, - { - "value": "\"input\"" - }, - { - "value": "\"ins\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"label\"" - }, - { - "value": "\"legend\"" - }, - { - "value": "\"li\"" - }, - { - "value": "\"link\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"map\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"meta\"" - }, - { - "value": "\"meter\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"ol\"" - }, - { - "value": "\"optgroup\"" - }, - { - "value": "\"option\"" - }, - { - "value": "\"output\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"param\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"pre\"" - }, - { - "value": "\"progress\"" - }, - { - "value": "\"q\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"slot\"" - }, - { - "value": "\"script\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"select\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"source\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"style\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"table\"" - }, - { - "value": "\"template\"" - }, - { - "value": "\"tbody\"" - }, - { - "value": "\"td\"" - }, - { - "value": "\"textarea\"" - }, - { - "value": "\"tfoot\"" - }, - { - "value": "\"th\"" - }, - { - "value": "\"thead\"" - }, - { - "value": "\"time\"" - }, - { - "value": "\"title\"" - }, - { - "value": "\"tr\"" - }, - { - "value": "\"track\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"ul\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"video\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "\"svg\"" - }, - { - "value": "\"animate\"" - }, - { - "value": "\"animateMotion\"" - }, - { - "value": "\"animateTransform\"" - }, - { - "value": "\"circle\"" - }, - { - "value": "\"clipPath\"" - }, - { - "value": "\"defs\"" - }, - { - "value": "\"desc\"" - }, - { - "value": "\"ellipse\"" - }, - { - "value": "\"feBlend\"" - }, - { - "value": "\"feColorMatrix\"" - }, - { - "value": "\"feComponentTransfer\"" - }, - { - "value": "\"feComposite\"" - }, - { - "value": "\"feConvolveMatrix\"" - }, - { - "value": "\"feDiffuseLighting\"" - }, - { - "value": "\"feDisplacementMap\"" - }, - { - "value": "\"feDistantLight\"" - }, - { - "value": "\"feDropShadow\"" - }, - { - "value": "\"feFlood\"" - }, - { - "value": "\"feFuncA\"" - }, - { - "value": "\"feFuncB\"" - }, - { - "value": "\"feFuncG\"" - }, - { - "value": "\"feFuncR\"" - }, - { - "value": "\"feGaussianBlur\"" - }, - { - "value": "\"feImage\"" - }, - { - "value": "\"feMerge\"" - }, - { - "value": "\"feMergeNode\"" - }, - { - "value": "\"feMorphology\"" - }, - { - "value": "\"feOffset\"" - }, - { - "value": "\"fePointLight\"" - }, - { - "value": "\"feSpecularLighting\"" - }, - { - "value": "\"feSpotLight\"" - }, - { - "value": "\"feTile\"" - }, - { - "value": "\"feTurbulence\"" - }, - { - "value": "\"filter\"" - }, - { - "value": "\"foreignObject\"" - }, - { - "value": "\"g\"" - }, - { - "value": "\"image\"" - }, - { - "value": "\"line\"" - }, - { - "value": "\"linearGradient\"" - }, - { - "value": "\"marker\"" - }, - { - "value": "\"mask\"" - }, - { - "value": "\"metadata\"" - }, - { - "value": "\"mpath\"" - }, - { - "value": "\"path\"" - }, - { - "value": "\"pattern\"" - }, - { - "value": "\"polygon\"" - }, - { - "value": "\"polyline\"" - }, - { - "value": "\"radialGradient\"" - }, - { - "value": "\"rect\"" - }, - { - "value": "\"stop\"" - }, - { - "value": "\"switch\"" - }, - { - "value": "\"text\"" - }, - { - "value": "\"textPath\"" - }, - { - "value": "\"tspan\"" - }, - { - "value": "\"use\"" - }, - { - "value": "\"view\"" - }, - { - "value": "ComponentClass", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "checked": { - "defaultValue": { - "value": false - }, - "description": "", - "name": "checked", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "indeterminate": { - "defaultValue": { - "value": false - }, - "description": "", - "name": "indeterminate", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "(event: ChangeEvent) => void" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/DatePicker/docs/properties.json b/lib/src/components/DatePicker/docs/properties.json deleted file mode 100644 index fc397b76a..000000000 --- a/lib/src/components/DatePicker/docs/properties.json +++ /dev/null @@ -1,362 +0,0 @@ -{ - "DatePicker": { - "props": { - "endYear": { - "defaultValue": { - "value": "DEFAULT_DATE.getFullYear()" - }, - "description": "", - "name": "endYear", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "welcome-ui/node_modules/@types/react-datepicker/index.d.ts", - "name": "ReactDatePickerProps" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@types/react-datepicker/index.d.ts", - "name": "ReactDatePickerProps" - }, - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "(string | ReactElement>) & Element", - "value": [ - { - "value": "string & Element" - }, - { - "value": "ReactElement> & Element" - } - ] - } - }, - "iconPlacement": { - "defaultValue": { - "value": "left" - }, - "description": "", - "name": "iconPlacement", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "IconPlacement", - "value": [ - { - "value": "\"right\"" - }, - { - "value": "\"left\"" - } - ] - } - }, - "locale": { - "defaultValue": null, - "description": "", - "name": "locale", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - } - ], - "required": false, - "type": { - "name": "Locale" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "(date?: Date) => void" - } - }, - "onFocus": { - "defaultValue": null, - "description": "", - "name": "onFocus", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "placeholder": { - "defaultValue": null, - "description": "", - "name": "placeholder", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "preventVirtualKeyboard": { - "defaultValue": { - "value": false - }, - "description": "", - "name": "preventVirtualKeyboard", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - } - ] - } - }, - "startYear": { - "defaultValue": { - "value": 1900 - }, - "description": "", - "name": "startYear", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "useWeekdaysShort": { - "defaultValue": { - "value": true - }, - "description": "", - "name": "useWeekdaysShort", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "value": { - "defaultValue": { - "value": "new Date()" - }, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | Date", - "value": [ - { - "value": "string" - }, - { - "value": "Date", - "description": "Enables basic storage and retrieval of dates and times.", - "fullComment": "Enables basic storage and retrieval of dates and times.", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/DateTimePicker/docs/properties.json b/lib/src/components/DateTimePicker/docs/properties.json deleted file mode 100644 index 3e77aeb7a..000000000 --- a/lib/src/components/DateTimePicker/docs/properties.json +++ /dev/null @@ -1,173 +0,0 @@ -{ - "DateTimePicker": { - "props": { - "locale": { - "defaultValue": null, - "description": "", - "name": "locale", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomHeader.tsx", - "name": "CustomHeaderOptions" - }, - { - "fileName": "welcome-ui/node_modules/@types/react-datepicker/index.d.ts", - "name": "ReactDatePickerProps" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Locale | (Locale & string)", - "value": [ - { - "value": "Locale", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "Locale & string" - } - ] - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "((date?: Date) => void) & ((date?: Date) => void)" - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - }, - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - } - ] - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "value": { - "defaultValue": { - "value": "new Date()" - }, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DatePicker/index.tsx", - "name": "DatePickerOptions" - }, - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | Date", - "value": [ - { - "value": "string" - }, - { - "value": "Date", - "description": "Enables basic storage and retrieval of dates and times.", - "fullComment": "Enables basic storage and retrieval of dates and times.", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Drawer/docs/properties.json b/lib/src/components/Drawer/docs/properties.json deleted file mode 100644 index 94a8220b3..000000000 --- a/lib/src/components/Drawer/docs/properties.json +++ /dev/null @@ -1,2286 +0,0 @@ -{ - "useDrawer": { - "props": { - "animated": { - "defaultValue": null, - "description": "Determines whether the content should animate when it is shown or hidden.\n- If `true`, the `animating` state will be `true` when the content is shown\n or hidden and it will wait for a CSS animation/transition to end before\n becoming `false`.\n- If it's set to a number, the `animating` state will be `true` when the\n content is shown or hidden and it will wait for the number of\n milliseconds to pass before becoming `false`.\n@deprecated Manually setting the `animated` prop is no longer necessary.\nThis will be removed in a future release.", - "name": "animated", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "number | boolean", - "value": [ - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "defaultOpen": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the content should be visible by default.", - "name": "defaultOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disclosure": { - "defaultValue": null, - "description": "A reference to another disclosure store that controls another disclosure\ncomponent to keep them in sync. Element states like `contentElement` and\n`disclosureElement` won't be synced. For that, use the\n[`store`](https://ariakit.org/reference/disclosure-provider#store) prop\ninstead.\n\nLive examples:\n- [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)", - "name": "disclosure", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "DisclosureStore" - } - }, - "setMounted": { - "defaultValue": null, - "description": "A callback that gets called when the `mounted` state changes.\n@example const [mounted, setMounted] = useState(false);\nconst disclosure = useDisclosureStore({ setMounted });", - "name": "setMounted", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(mounted: boolean) => void" - } - }, - "setOpen": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state\nchanges.\n@example const [open, setOpen] = useState(false);\nconst disclosure = useDisclosureStore({ open, setOpen });", - "name": "setOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(open: boolean) => void" - } - } - } - }, - "Drawer.Backdrop": { - "props": { - "hideOnInteractOutside": { - "defaultValue": { - "value": true - }, - "description": "", - "name": "hideOnInteractOutside", - "parent": { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerBackdropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerBackdropOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - } - } - }, - "Trigger": { - "props": {} - }, - "Drawer": { - "props": { - "accessibleWhenDisabled": { - "defaultValue": null, - "description": "Indicates whether the element should be focusable even when it is\n[`disabled`](https://ariakit.org/reference/focusable#disabled).\n\nThis is important when discoverability is a concern. For example:\n\n> A toolbar in an editor contains a set of special smart paste functions\nthat are disabled when the clipboard is empty or when the function is not\napplicable to the current content of the clipboard. It could be helpful to\nkeep the disabled buttons focusable if the ability to discover their\nfunctionality is primarily via their presence on the toolbar.\n\nLearn more on [Focusability of disabled\ncontrols](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "accessibleWhenDisabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "alwaysVisible": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the content element should remain visible even when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state is\n`false`. If this prop is set to `true`, the `hidden` prop and the `display:\nnone` style will not be applied, unless explicitly set otherwise.\n\nThis prop is particularly useful when using third-party animation libraries\nsuch as Framer Motion or React Spring, where the element needs to be\nvisible for exit animations to work.\n\nLive examples:\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Menu with Framer\n Motion](https://ariakit.org/examples/menu-framer-motion)\n- [Tooltip with Framer\n Motion](https://ariakit.org/examples/tooltip-framer-motion)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)", - "name": "alwaysVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocus": { - "defaultValue": { - "value": "false" - }, - "description": "Automatically focuses the element upon mounting, similar to the native\n`autoFocus` prop. This addresses an issue where the element with the native\n`autoFocus` attribute might receive focus before React effects are\nexecuted.\n\nThe `autoFocus` prop can also be used with\n[Focusable](https://ariakit.org/components/focusable) elements within a\n[Dialog](https://ariakit.org/components/dialog) component, establishing the\ninitial focus as the dialog opens.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with React\n Router](https://ariakit.org/examples/dialog-react-router)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)", - "name": "autoFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocusOnHide": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element outside of the dialog will be focused when\nthe dialog is hidden if another element hasn't been focused in the action\nof hiding the dialog (for example, by clicking or tabbing into another\ntabbable element outside of the dialog).\n\nBy default, this is usually the disclosure element. The\n[`finalFocus`](https://ariakit.org/reference/dialog#finalfocus) prop can be\nused to define a different element to be focused.\n\nLive examples:\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n- [Sliding menu](https://ariakit.org/examples/menu-slide)", - "name": "autoFocusOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoFocusOnShow": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element inside the dialog will receive focus when the\ndialog is shown. By default, this is usually the first tabbable element in\nthe dialog or the dialog itself. The\n[`initialFocus`](https://ariakit.org/reference/dialog#initialfocus) prop\ncan be used to set a different element to receive focus.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "autoFocusOnShow", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "backdrop": { - "defaultValue": null, - "description": "Determines whether there will be a backdrop behind the dialog. On modal\ndialogs, this is `true` by default. Besides a `boolean`, this prop can also\nbe a React component or JSX element that will be rendered as the backdrop.\n\n**Note**: If a custom component is used, it must [accept ref and spread all\nprops to its underlying DOM\nelement](https://ariakit.org/guide/composition#custom-components-must-be-open-for-extension),\nthe same way a native element would.\n\nLive examples:\n- [Animated Dialog](https://ariakit.org/examples/dialog-animated)\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n@example ```jsx\n} />\n```", - "name": "backdrop", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean | ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes<...>> & { ...; }, string | JSXElementConstructor<...>> | ElementType<...>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, string | JSXElementConstructor<...>>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ComponentClass, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, any>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "disabled": { - "defaultValue": { - "value": "false" - }, - "description": "Determines if the element is disabled. This sets the `aria-disabled`\nattribute accordingly, enabling support for all elements, including those\nthat don't support the native `disabled` attribute.\n\nThis feature can be combined with the\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled)\nprop to make disabled elements still accessible via keyboard.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Context Menu](https://ariakit.org/examples/menu-context-menu)", - "name": "disabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "finalFocus": { - "defaultValue": null, - "description": "Determines the element that will receive focus once the dialog is closed,\nprovided that no other element has been focused while the dialog was being\nhidden (e.g., by clicking or tabbing into another tabbable element outside\nof the dialog).\n- If\n [`autoFocusOnHide`](https://ariakit.org/reference/dialog#autofocusonhide)\n is set to `false`, this prop will have no effect.\n- If left unset, the element that was focused before the dialog was opened\n will be focused again.", - "name": "finalFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "focusable": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if [Focusable](https://ariakit.org/components/focusable)\nfeatures should be active on non-native focusable elements.\n\n**Note**: This prop only turns off the additional features provided by the\n[`Focusable`](https://ariakit.org/reference/focusable) component.\nNon-native focusable elements will lose their focusability entirely.\nHowever, native focusable elements will retain their inherent focusability,\nbut without added features such as improved\n[`autoFocus`](https://ariakit.org/reference/focusable#autofocus),\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled),\n[`onFocusVisible`](https://ariakit.org/reference/focusable#onfocusvisible),\netc.", - "name": "focusable", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "getPersistentElements": { - "defaultValue": null, - "description": "When a dialog is open, the elements outside of it are disabled to prevent\ninteraction if the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). For non-modal\ndialogs, interacting with elements outside the dialog prompts it to close.\n\nThis function allows you to return an iterable collection of elements that\nwill be considered as part of the dialog, thus excluding them from this\nbehavior.\n\n**Note**: The elements returned by this function must exist in the DOM when\nthe dialog opens.\n\nLive examples:\n- [Dialog with\n React-Toastify](https://ariakit.org/examples/dialog-react-toastify)", - "name": "getPersistentElements", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "() => Iterable" - } - }, - "hideOnEscape": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog will hide when the user presses the Escape key.\n\nThis prop can be either a boolean or a function that accepts an event as an\nargument and returns a boolean. The event object represents the keydown\nevent that initiated the hide action, which could be either a native\nkeyboard event or a React synthetic event.\n\n**Note**: When placing Ariakit dialogs inside third-party dialogs, using\n`event.stopPropagation()` within this function will stop the event from\nreaching the third-party dialog, closing only the Ariakit dialog.", - "name": "hideOnEscape", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: KeyboardEvent | React.KeyboardEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnInteractOutside": { - "defaultValue": { - "value": true - }, - "description": "Determines if the dialog should hide when the user clicks or focuses on an\nelement outside the dialog.\n\nThis prop can be either a boolean or a function that takes an event as an\nargument and returns a boolean. The event object represents the event that\ntriggered the action, which could be a native event or a React synthetic\nevent of various types.\n\nLive examples:\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "hideOnInteractOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: Event | SyntheticEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "initialFocus": { - "defaultValue": null, - "description": "Specifies the element that will receive focus when the dialog is first\nopened. It can be an `HTMLElement` or a `React.RefObject` with an\n`HTMLElement`.\n\nIf\n[`autoFocusOnShow`](https://ariakit.org/reference/dialog#autofocusonshow)\nis set to `false`, this prop will have no effect. If left unset, the dialog\nwill attempt to determine the initial focus element in the following order:\n1. A [Focusable](https://ariakit.org/components/focusable) element with an\n [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.\n2. The first tabbable element inside the dialog.\n3. The first focusable element inside the dialog.\n4. The dialog element itself.", - "name": "initialFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "modal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the dialog is modal. Modal dialogs have distinct states\nand behaviors:\n- The [`portal`](https://ariakit.org/reference/dialog#portal) and\n [`preventBodyScroll`](https://ariakit.org/reference/dialog#preventbodyscroll)\n props are set to `true`. They can still be manually set to `false`.\n- When using the [`Heading`](https://ariakit.org/reference/heading) or\n [`DialogHeading`](https://ariakit.org/reference/dialog-heading)\n components within the dialog, their level will be reset so they start\n with `h1`.\n- A visually hidden dismiss button will be rendered if the\n [`DialogDismiss`](https://ariakit.org/reference/dialog-dismiss) component\n hasn't been used. This allows screen reader users to close the dialog.\n- When the dialog is open, element tree outside it will be inert.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Context menu](https://ariakit.org/examples/menu-context-menu)\n- [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "modal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "onClose": { - "defaultValue": null, - "description": "This is an event handler prop triggered when the dialog's `close` event is\ndispatched. The `close` event is similar to the native dialog\n[`close`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/close_event)\nevent. The only difference is that this event can be canceled with\n`event.preventDefault()`, which will prevent the dialog from hiding.\n\nIt's important to note that this event only fires when the dialog store's\n[`open`](https://ariakit.org/reference/use-dialog-store#open) state is set\nto `false`. If the controlled\n[`open`](https://ariakit.org/reference/dialog#open) prop value changes, or\nif the dialog's visibility is altered in any other way (such as unmounting\nthe dialog without adjusting the open state), this event won't be\ntriggered.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "onClose", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "(event: Event) => void" - } - }, - "onFocusVisible": { - "defaultValue": null, - "description": "Custom event handler invoked when the element gains focus through keyboard\ninteraction or a key press occurs while the element is in focus. This is\nthe programmatic equivalent of the\n[`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible)\nattribute.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)", - "name": "onFocusVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(event: SyntheticEvent) => void>" - } - }, - "open": { - "defaultValue": null, - "description": "Controls the open state of the dialog. This is similar to the\n[`open`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/open)\nattribute on native dialog elements.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "open", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "placement": { - "defaultValue": { - "value": "right" - }, - "description": "", - "name": "placement", - "parent": { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Placement", - "value": [ - { - "value": "\"top\"" - }, - { - "value": "\"right\"" - }, - { - "value": "\"bottom\"" - }, - { - "value": "\"left\"" - } - ] - } - }, - "portal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the element should be rendered as a React Portal.\n\nLive examples:\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Hovercard with keyboard\n support](https://ariakit.org/examples/hovercard-disclosure)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)", - "name": "portal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portalElement": { - "defaultValue": null, - "description": "An HTML element or a memoized callback function that returns an HTML\nelement to be used as the portal element. By default, the portal element\nwill be a `div` element appended to the `document.body`.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n@example ```jsx\nconst [portal, setPortal] = useState(null);\n\n\n
\n```\n@example ```jsx\nconst getPortalElement = useCallback(() => {\n const div = document.createElement(\"div\");\n const portalRoot = document.getElementById(\"portal-root\");\n portalRoot.appendChild(div);\n return div;\n}, []);\n\n\n```", - "name": "portalElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | ((element: HTMLElement) => HTMLElement)", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "(element: HTMLElement) => HTMLElement", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "portalRef": { - "defaultValue": null, - "description": "`portalRef` is similar to `ref` but is scoped to the portal node. It's\nuseful when you need to be informed when the portal element is appended to\nthe DOM or removed from the DOM.\n\nLive examples:\n- [Form with Select](https://ariakit.org/examples/form-select)\n@example ```jsx\nconst [portalElement, setPortalElement] = useState(null);\n\n\n```", - "name": "portalRef", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "RefCallback | MutableRefObject", - "value": [ - { - "value": "RefCallback", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "MutableRefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "preserveTabOrder": { - "defaultValue": { - "value": "false" - }, - "description": "When enabled, `preserveTabOrder` will keep the DOM element's tab order the\nsame as the order in which the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted in\nthe React tree.\n\nIf the\n[`preserveTabOrderAnchor`](https://ariakit.org/reference/portal#preservetaborderanchor)\nprop is provided, the tab order will be preserved relative to that element.", - "name": "preserveTabOrder", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "preserveTabOrderAnchor": { - "defaultValue": null, - "description": "An anchor element for maintaining the tab order when\n[`preserveTabOrder`](https://ariakit.org/reference/portal#preservetaborder)\nprop is enabled. The tab order will be kept relative to this element.\n\nBy default, the tab order is kept relative to the original location in the\nReact tree where the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted.\n@example ```jsx {18-20}\nconst [anchor, setAnchor] = useState(null);\n\n\n\n\n// Rendered at the end of the document.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved\n// relative to the anchor element.\n\n \n\n\n\n```", - "name": "preserveTabOrderAnchor", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "preventBodyScroll": { - "defaultValue": null, - "description": "Determines whether the body scrolling will be prevented when the dialog is\nshown. This is automatically set to `true` when the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). You can disable this\nprop if you want to implement your own logic.", - "name": "preventBodyScroll", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "render": { - "defaultValue": null, - "description": "Allows the component to be rendered as a different HTML element or React\ncomponent. The value can be a React element or a function that takes in the\noriginal component props and gives back a React element with the props\nmerged.\n\nCheck out the [Composition](https://ariakit.org/guide/composition) guide\nfor more details.", - "name": "render", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ReactElement> | RenderProp & { ref?: Ref; }>", - "value": [ - { - "value": "ReactElement>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "RenderProp & { ref?: Ref; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "size": { - "defaultValue": { - "value": "lg" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "store": { - "defaultValue": null, - "description": "Object returned by the\n[`useDialogStore`](https://ariakit.org/reference/use-dialog-store) hook. If\nnot provided, the closest\n[`DialogProvider`](https://ariakit.org/reference/dialog-provider)\ncomponent's context will be used. Otherwise, an internal store will be\ncreated.", - "name": "store", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "DialogStore" - } - }, - "unmountOnHide": { - "defaultValue": { - "value": "false" - }, - "description": "When set to `true`, the content element will be unmounted and removed from\nthe DOM when it's hidden.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)\n- [Multi-Select](https://ariakit.org/examples/select-multiple)", - "name": "unmountOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "unstable_treeSnapshotKey": { - "defaultValue": null, - "description": "@private", - "name": "unstable_treeSnapshotKey", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | number | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "withBackdrop": { - "defaultValue": { - "value": false - }, - "description": "", - "name": "withBackdrop", - "parent": { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "withCloseButton": { - "defaultValue": { - "value": true - }, - "description": "", - "name": "withCloseButton", - "parent": { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Drawer/index.tsx", - "name": "DrawerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "wrapElement": { - "defaultValue": null, - "description": "", - "name": "wrapElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "WrapElement" - } - } - } - }, - "AssetDrawer": { - "props": { - "accessibleWhenDisabled": { - "defaultValue": null, - "description": "Indicates whether the element should be focusable even when it is\n[`disabled`](https://ariakit.org/reference/focusable#disabled).\n\nThis is important when discoverability is a concern. For example:\n\n> A toolbar in an editor contains a set of special smart paste functions\nthat are disabled when the clipboard is empty or when the function is not\napplicable to the current content of the clipboard. It could be helpful to\nkeep the disabled buttons focusable if the ability to discover their\nfunctionality is primarily via their presence on the toolbar.\n\nLearn more on [Focusability of disabled\ncontrols](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "accessibleWhenDisabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "alwaysVisible": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the content element should remain visible even when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state is\n`false`. If this prop is set to `true`, the `hidden` prop and the `display:\nnone` style will not be applied, unless explicitly set otherwise.\n\nThis prop is particularly useful when using third-party animation libraries\nsuch as Framer Motion or React Spring, where the element needs to be\nvisible for exit animations to work.\n\nLive examples:\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Menu with Framer\n Motion](https://ariakit.org/examples/menu-framer-motion)\n- [Tooltip with Framer\n Motion](https://ariakit.org/examples/tooltip-framer-motion)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)", - "name": "alwaysVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocus": { - "defaultValue": { - "value": "false" - }, - "description": "Automatically focuses the element upon mounting, similar to the native\n`autoFocus` prop. This addresses an issue where the element with the native\n`autoFocus` attribute might receive focus before React effects are\nexecuted.\n\nThe `autoFocus` prop can also be used with\n[Focusable](https://ariakit.org/components/focusable) elements within a\n[Dialog](https://ariakit.org/components/dialog) component, establishing the\ninitial focus as the dialog opens.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with React\n Router](https://ariakit.org/examples/dialog-react-router)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)", - "name": "autoFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocusOnHide": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element outside of the dialog will be focused when\nthe dialog is hidden if another element hasn't been focused in the action\nof hiding the dialog (for example, by clicking or tabbing into another\ntabbable element outside of the dialog).\n\nBy default, this is usually the disclosure element. The\n[`finalFocus`](https://ariakit.org/reference/dialog#finalfocus) prop can be\nused to define a different element to be focused.\n\nLive examples:\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n- [Sliding menu](https://ariakit.org/examples/menu-slide)", - "name": "autoFocusOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoFocusOnShow": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element inside the dialog will receive focus when the\ndialog is shown. By default, this is usually the first tabbable element in\nthe dialog or the dialog itself. The\n[`initialFocus`](https://ariakit.org/reference/dialog#initialfocus) prop\ncan be used to set a different element to receive focus.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "autoFocusOnShow", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "backdrop": { - "defaultValue": null, - "description": "Determines whether there will be a backdrop behind the dialog. On modal\ndialogs, this is `true` by default. Besides a `boolean`, this prop can also\nbe a React component or JSX element that will be rendered as the backdrop.\n\n**Note**: If a custom component is used, it must [accept ref and spread all\nprops to its underlying DOM\nelement](https://ariakit.org/guide/composition#custom-components-must-be-open-for-extension),\nthe same way a native element would.\n\nLive examples:\n- [Animated Dialog](https://ariakit.org/examples/dialog-animated)\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n@example ```jsx\n} />\n```", - "name": "backdrop", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean | ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes<...>> & { ...; }, string | JSXElementConstructor<...>> | ElementType<...>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, string | JSXElementConstructor<...>>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ComponentClass, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, any>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "disabled": { - "defaultValue": { - "value": "false" - }, - "description": "Determines if the element is disabled. This sets the `aria-disabled`\nattribute accordingly, enabling support for all elements, including those\nthat don't support the native `disabled` attribute.\n\nThis feature can be combined with the\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled)\nprop to make disabled elements still accessible via keyboard.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Context Menu](https://ariakit.org/examples/menu-context-menu)", - "name": "disabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "finalFocus": { - "defaultValue": null, - "description": "Determines the element that will receive focus once the dialog is closed,\nprovided that no other element has been focused while the dialog was being\nhidden (e.g., by clicking or tabbing into another tabbable element outside\nof the dialog).\n- If\n [`autoFocusOnHide`](https://ariakit.org/reference/dialog#autofocusonhide)\n is set to `false`, this prop will have no effect.\n- If left unset, the element that was focused before the dialog was opened\n will be focused again.", - "name": "finalFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "focusable": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if [Focusable](https://ariakit.org/components/focusable)\nfeatures should be active on non-native focusable elements.\n\n**Note**: This prop only turns off the additional features provided by the\n[`Focusable`](https://ariakit.org/reference/focusable) component.\nNon-native focusable elements will lose their focusability entirely.\nHowever, native focusable elements will retain their inherent focusability,\nbut without added features such as improved\n[`autoFocus`](https://ariakit.org/reference/focusable#autofocus),\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled),\n[`onFocusVisible`](https://ariakit.org/reference/focusable#onfocusvisible),\netc.", - "name": "focusable", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "getPersistentElements": { - "defaultValue": null, - "description": "When a dialog is open, the elements outside of it are disabled to prevent\ninteraction if the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). For non-modal\ndialogs, interacting with elements outside the dialog prompts it to close.\n\nThis function allows you to return an iterable collection of elements that\nwill be considered as part of the dialog, thus excluding them from this\nbehavior.\n\n**Note**: The elements returned by this function must exist in the DOM when\nthe dialog opens.\n\nLive examples:\n- [Dialog with\n React-Toastify](https://ariakit.org/examples/dialog-react-toastify)", - "name": "getPersistentElements", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "() => Iterable" - } - }, - "hideOnEscape": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog will hide when the user presses the Escape key.\n\nThis prop can be either a boolean or a function that accepts an event as an\nargument and returns a boolean. The event object represents the keydown\nevent that initiated the hide action, which could be either a native\nkeyboard event or a React synthetic event.\n\n**Note**: When placing Ariakit dialogs inside third-party dialogs, using\n`event.stopPropagation()` within this function will stop the event from\nreaching the third-party dialog, closing only the Ariakit dialog.", - "name": "hideOnEscape", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: KeyboardEvent | React.KeyboardEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnInteractOutside": { - "defaultValue": { - "value": true - }, - "description": "Determines if the dialog should hide when the user clicks or focuses on an\nelement outside the dialog.\n\nThis prop can be either a boolean or a function that takes an event as an\nargument and returns a boolean. The event object represents the event that\ntriggered the action, which could be a native event or a React synthetic\nevent of various types.\n\nLive examples:\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "hideOnInteractOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: Event | SyntheticEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "initialFocus": { - "defaultValue": null, - "description": "Specifies the element that will receive focus when the dialog is first\nopened. It can be an `HTMLElement` or a `React.RefObject` with an\n`HTMLElement`.\n\nIf\n[`autoFocusOnShow`](https://ariakit.org/reference/dialog#autofocusonshow)\nis set to `false`, this prop will have no effect. If left unset, the dialog\nwill attempt to determine the initial focus element in the following order:\n1. A [Focusable](https://ariakit.org/components/focusable) element with an\n [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.\n2. The first tabbable element inside the dialog.\n3. The first focusable element inside the dialog.\n4. The dialog element itself.", - "name": "initialFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "modal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the dialog is modal. Modal dialogs have distinct states\nand behaviors:\n- The [`portal`](https://ariakit.org/reference/dialog#portal) and\n [`preventBodyScroll`](https://ariakit.org/reference/dialog#preventbodyscroll)\n props are set to `true`. They can still be manually set to `false`.\n- When using the [`Heading`](https://ariakit.org/reference/heading) or\n [`DialogHeading`](https://ariakit.org/reference/dialog-heading)\n components within the dialog, their level will be reset so they start\n with `h1`.\n- A visually hidden dismiss button will be rendered if the\n [`DialogDismiss`](https://ariakit.org/reference/dialog-dismiss) component\n hasn't been used. This allows screen reader users to close the dialog.\n- When the dialog is open, element tree outside it will be inert.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Context menu](https://ariakit.org/examples/menu-context-menu)\n- [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "modal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "onClose": { - "defaultValue": null, - "description": "This is an event handler prop triggered when the dialog's `close` event is\ndispatched. The `close` event is similar to the native dialog\n[`close`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/close_event)\nevent. The only difference is that this event can be canceled with\n`event.preventDefault()`, which will prevent the dialog from hiding.\n\nIt's important to note that this event only fires when the dialog store's\n[`open`](https://ariakit.org/reference/use-dialog-store#open) state is set\nto `false`. If the controlled\n[`open`](https://ariakit.org/reference/dialog#open) prop value changes, or\nif the dialog's visibility is altered in any other way (such as unmounting\nthe dialog without adjusting the open state), this event won't be\ntriggered.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "onClose", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "(event: Event) => void" - } - }, - "onFocusVisible": { - "defaultValue": null, - "description": "Custom event handler invoked when the element gains focus through keyboard\ninteraction or a key press occurs while the element is in focus. This is\nthe programmatic equivalent of the\n[`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible)\nattribute.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)", - "name": "onFocusVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(event: SyntheticEvent) => void>" - } - }, - "open": { - "defaultValue": null, - "description": "Controls the open state of the dialog. This is similar to the\n[`open`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/open)\nattribute on native dialog elements.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "open", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the element should be rendered as a React Portal.\n\nLive examples:\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Hovercard with keyboard\n support](https://ariakit.org/examples/hovercard-disclosure)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)", - "name": "portal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portalElement": { - "defaultValue": null, - "description": "An HTML element or a memoized callback function that returns an HTML\nelement to be used as the portal element. By default, the portal element\nwill be a `div` element appended to the `document.body`.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n@example ```jsx\nconst [portal, setPortal] = useState(null);\n\n\n
\n```\n@example ```jsx\nconst getPortalElement = useCallback(() => {\n const div = document.createElement(\"div\");\n const portalRoot = document.getElementById(\"portal-root\");\n portalRoot.appendChild(div);\n return div;\n}, []);\n\n\n```", - "name": "portalElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | ((element: HTMLElement) => HTMLElement)", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "(element: HTMLElement) => HTMLElement", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "portalRef": { - "defaultValue": null, - "description": "`portalRef` is similar to `ref` but is scoped to the portal node. It's\nuseful when you need to be informed when the portal element is appended to\nthe DOM or removed from the DOM.\n\nLive examples:\n- [Form with Select](https://ariakit.org/examples/form-select)\n@example ```jsx\nconst [portalElement, setPortalElement] = useState(null);\n\n\n```", - "name": "portalRef", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "RefCallback | MutableRefObject", - "value": [ - { - "value": "RefCallback", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "MutableRefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "preserveTabOrder": { - "defaultValue": { - "value": "false" - }, - "description": "When enabled, `preserveTabOrder` will keep the DOM element's tab order the\nsame as the order in which the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted in\nthe React tree.\n\nIf the\n[`preserveTabOrderAnchor`](https://ariakit.org/reference/portal#preservetaborderanchor)\nprop is provided, the tab order will be preserved relative to that element.", - "name": "preserveTabOrder", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "preserveTabOrderAnchor": { - "defaultValue": null, - "description": "An anchor element for maintaining the tab order when\n[`preserveTabOrder`](https://ariakit.org/reference/portal#preservetaborder)\nprop is enabled. The tab order will be kept relative to this element.\n\nBy default, the tab order is kept relative to the original location in the\nReact tree where the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted.\n@example ```jsx {18-20}\nconst [anchor, setAnchor] = useState(null);\n\n\n\n\n// Rendered at the end of the document.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved\n// relative to the anchor element.\n\n \n\n\n\n```", - "name": "preserveTabOrderAnchor", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "preventBodyScroll": { - "defaultValue": null, - "description": "Determines whether the body scrolling will be prevented when the dialog is\nshown. This is automatically set to `true` when the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). You can disable this\nprop if you want to implement your own logic.", - "name": "preventBodyScroll", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "render": { - "defaultValue": null, - "description": "Allows the component to be rendered as a different HTML element or React\ncomponent. The value can be a React element or a function that takes in the\noriginal component props and gives back a React element with the props\nmerged.\n\nCheck out the [Composition](https://ariakit.org/guide/composition) guide\nfor more details.", - "name": "render", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ReactElement> | RenderProp & { ref?: Ref; }>", - "value": [ - { - "value": "ReactElement>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "RenderProp & { ref?: Ref; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "store": { - "defaultValue": null, - "description": "Object returned by the\n[`useDialogStore`](https://ariakit.org/reference/use-dialog-store) hook. If\nnot provided, the closest\n[`DialogProvider`](https://ariakit.org/reference/dialog-provider)\ncomponent's context will be used. Otherwise, an internal store will be\ncreated.", - "name": "store", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "DialogStore" - } - }, - "unmountOnHide": { - "defaultValue": { - "value": "false" - }, - "description": "When set to `true`, the content element will be unmounted and removed from\nthe DOM when it's hidden.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)\n- [Multi-Select](https://ariakit.org/examples/select-multiple)", - "name": "unmountOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "unstable_treeSnapshotKey": { - "defaultValue": null, - "description": "@private", - "name": "unstable_treeSnapshotKey", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | number | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "wrapElement": { - "defaultValue": null, - "description": "", - "name": "wrapElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "WrapElement" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/DropdownMenu/docs/properties.json b/lib/src/components/DropdownMenu/docs/properties.json deleted file mode 100644 index 89a7bc2ec..000000000 --- a/lib/src/components/DropdownMenu/docs/properties.json +++ /dev/null @@ -1,1872 +0,0 @@ -{ - "useDropdownMenu": { - "props": { - "animated": { - "defaultValue": null, - "description": "Determines whether the content should animate when it is shown or hidden.\n- If `true`, the `animating` state will be `true` when the content is shown\n or hidden and it will wait for a CSS animation/transition to end before\n becoming `false`.\n- If it's set to a number, the `animating` state will be `true` when the\n content is shown or hidden and it will wait for the number of\n milliseconds to pass before becoming `false`.\n@deprecated Manually setting the `animated` prop is no longer necessary.\nThis will be removed in a future release.", - "name": "animated", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "number | boolean", - "value": [ - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "combobox": { - "defaultValue": null, - "description": "A reference to a [combobox\nstore](https://ariakit.org/reference/use-combobox-store). It's\nautomatically set when composing [Menu with\nCombobox](https://ariakit.org/examples/menu-combobox).", - "name": "combobox", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - } - ], - "required": false, - "type": { - "name": "ComboboxStore" - } - }, - "defaultActiveId": { - "defaultValue": null, - "description": "The composite item id that should be active by default when the composite\nwidget is rendered. If `null`, the composite element itself will have focus\nand users will be able to navigate to it using arrow keys. If `undefined`,\nthe first enabled item will be focused.", - "name": "defaultActiveId", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "defaultItems": { - "defaultValue": { - "value": "[]" - }, - "description": "The defaut value for the\n[`items`](https://ariakit.org/reference/collection-provider#items) state.", - "name": "defaultItems", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - } - ], - "required": false, - "type": { - "name": "CompositeStoreItem[]" - } - }, - "defaultOpen": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the content should be visible by default.", - "name": "defaultOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "defaultValues": { - "defaultValue": { - "value": "{}" - }, - "description": "The default values for the\n[`values`](https://ariakit.org/reference/menu-provider#values) state.\n\nLive examples:\n- [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)\n- [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)", - "name": "defaultValues", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - } - ], - "required": false, - "type": { - "name": "MenuStoreValues" - } - }, - "disclosure": { - "defaultValue": null, - "description": "A reference to another disclosure store that controls another disclosure\ncomponent to keep them in sync. Element states like `contentElement` and\n`disclosureElement` won't be synced. For that, use the\n[`store`](https://ariakit.org/reference/disclosure-provider#store) prop\ninstead.\n\nLive examples:\n- [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)", - "name": "disclosure", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "DisclosureStore" - } - }, - "menubar": { - "defaultValue": null, - "description": "A reference to a [menubar\nstore](https://ariakit.org/reference/use-menubar-store). It's automatically\nset when rendering menus inside a\n[`Menubar`](https://ariakit.org/reference/menubar) in the React tree.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)", - "name": "menubar", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - } - ], - "required": false, - "type": { - "name": "MenubarStore" - } - }, - "parent": { - "defaultValue": null, - "description": "A reference to a parent menu store. It's automatically set when nesting\nmenus in the React tree. You should manually set this if menus aren't\nnested in the React tree.\n\nLive examples:\n- [Menubar](https://ariakit.org/components/menubar)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)", - "name": "parent", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - } - ], - "required": false, - "type": { - "name": "MenuStore" - } - }, - "popover": { - "defaultValue": null, - "description": "A reference to another popover store that's controlling another popover to\nkeep them in sync.", - "name": "popover", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts", - "name": "PopoverStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts", - "name": "PopoverStoreOptions" - } - ], - "required": false, - "type": { - "name": "PopoverStore" - } - }, - "setActiveId": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`activeId`](https://ariakit.org/reference/composite-provider#activeid)\nstate changes.", - "name": "setActiveId", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - } - ], - "required": false, - "type": { - "name": "(activeId: string) => void" - } - }, - "setItems": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`items`](https://ariakit.org/reference/collection-provider#items) state\nchanges.\n@example const [items, setItems] = useState([]);\nconst collection = useCollectionStore({ items, setItems });", - "name": "setItems", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(items: CompositeStoreItem[]) => void>" - } - }, - "setMounted": { - "defaultValue": null, - "description": "A callback that gets called when the `mounted` state changes.\n@example const [mounted, setMounted] = useState(false);\nconst disclosure = useDisclosureStore({ setMounted });", - "name": "setMounted", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(mounted: boolean) => void" - } - }, - "setOpen": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state\nchanges.\n@example const [open, setOpen] = useState(false);\nconst disclosure = useDisclosureStore({ open, setOpen });", - "name": "setOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(open: boolean) => void" - } - }, - "setValues": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`values`](https://ariakit.org/reference/menu-provider#values) state\nchanges.\n\nLive examples:\n- [MenuItemCheckbox](https://ariakit.org/examples/menu-item-checkbox)\n- [Submenu with\n Combobox](https://ariakit.org/examples/menu-nested-combobox)", - "name": "setValues", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-store.d.ts", - "name": "MenuStoreOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(values: MenuStoreValues) => void>" - } - } - } - }, - "DropdownMenu": { - "props": { - "accessibleWhenDisabled": { - "defaultValue": null, - "description": "Indicates whether the element should be focusable even when it is\n[`disabled`](https://ariakit.org/reference/focusable#disabled).\n\nThis is important when discoverability is a concern. For example:\n\n> A toolbar in an editor contains a set of special smart paste functions\nthat are disabled when the clipboard is empty or when the function is not\napplicable to the current content of the clipboard. It could be helpful to\nkeep the disabled buttons focusable if the ability to discover their\nfunctionality is primarily via their presence on the toolbar.\n\nLearn more on [Focusability of disabled\ncontrols](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "accessibleWhenDisabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "alwaysVisible": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the content element should remain visible even when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state is\n`false`. If this prop is set to `true`, the `hidden` prop and the `display:\nnone` style will not be applied, unless explicitly set otherwise.\n\nThis prop is particularly useful when using third-party animation libraries\nsuch as Framer Motion or React Spring, where the element needs to be\nvisible for exit animations to work.\n\nLive examples:\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Menu with Framer\n Motion](https://ariakit.org/examples/menu-framer-motion)\n- [Tooltip with Framer\n Motion](https://ariakit.org/examples/tooltip-framer-motion)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)", - "name": "alwaysVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "arrowPadding": { - "defaultValue": { - "value": "4" - }, - "description": "The minimum padding between the arrow and the popover corner.", - "name": "arrowPadding", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "autoFocus": { - "defaultValue": { - "value": "false" - }, - "description": "Automatically focuses the element upon mounting, similar to the native\n`autoFocus` prop. This addresses an issue where the element with the native\n`autoFocus` attribute might receive focus before React effects are\nexecuted.\n\nThe `autoFocus` prop can also be used with\n[Focusable](https://ariakit.org/components/focusable) elements within a\n[Dialog](https://ariakit.org/components/dialog) component, establishing the\ninitial focus as the dialog opens.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with React\n Router](https://ariakit.org/examples/dialog-react-router)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)", - "name": "autoFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocusOnHide": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element outside of the dialog will be focused when\nthe dialog is hidden if another element hasn't been focused in the action\nof hiding the dialog (for example, by clicking or tabbing into another\ntabbable element outside of the dialog).\n\nBy default, this is usually the disclosure element. The\n[`finalFocus`](https://ariakit.org/reference/dialog#finalfocus) prop can be\nused to define a different element to be focused.\n\nLive examples:\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n- [Sliding menu](https://ariakit.org/examples/menu-slide)", - "name": "autoFocusOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoFocusOnShow": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element inside the dialog will receive focus when the\ndialog is shown. By default, this is usually the first tabbable element in\nthe dialog or the dialog itself. The\n[`initialFocus`](https://ariakit.org/reference/dialog#initialfocus) prop\ncan be used to set a different element to receive focus.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "autoFocusOnShow", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "backdrop": { - "defaultValue": null, - "description": "Determines whether there will be a backdrop behind the dialog. On modal\ndialogs, this is `true` by default. Besides a `boolean`, this prop can also\nbe a React component or JSX element that will be rendered as the backdrop.\n\n**Note**: If a custom component is used, it must [accept ref and spread all\nprops to its underlying DOM\nelement](https://ariakit.org/guide/composition#custom-components-must-be-open-for-extension),\nthe same way a native element would.\n\nLive examples:\n- [Animated Dialog](https://ariakit.org/examples/dialog-animated)\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n@example ```jsx\n} />\n```", - "name": "backdrop", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean | ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes<...>> & { ...; }, string | JSXElementConstructor<...>> | ElementType<...>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, string | JSXElementConstructor<...>>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ComponentClass, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, any>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "composite": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the component should act as a composite widget. This prop\nneeds to be set to `false` when merging various composite widgets where\nonly one should function in that manner.\n\nIf disabled, this component will stop managing focus and keyboard\nnavigation for its items and itself. Additionally, composite ARIA\nattributes won't be applied. These responsibilities should be taken over by\nanother composite component.\n\n**Note**: In most cases, this prop doesn't need to be set manually. For\nexample, when composing [Menu with\nCombobox](https://ariakit.org/examples/menu-combobox) or [Select with\nCombobox](https://ariakit.org/examples/select-combobox), this prop will be\nset to `false` automatically on the\n[`Menu`](https://ariakit.org/reference/menu) and\n[`SelectPopover`](https://ariakit.org/reference/select-popover) components\nso the [`Combobox`](https://ariakit.org/reference/combobox) component can\ntake over the composite widget responsibilities.\n\nLive examples:\n- [Menu with Combobox](https://ariakit.org/examples/menu-combobox)\n- [Select with Combobox](https://ariakit.org/examples/select-combobox)", - "name": "composite", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disablePointerEventsOnApproach": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the pointer events outside of the popover and its anchor\nelement should be disabled during _hover intent_, that is, when the mouse\nis moving toward the popover.\n\nThis is required as these external events may trigger focus on other\nelements and close the popover while the user is attempting to hover over\nit.\n\nThis can be either a boolean or a callback receiving the mouse event\nhappening during hover intent. The callback should return a boolean.", - "name": "disablePointerEventsOnApproach", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: MouseEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "disabled": { - "defaultValue": { - "value": "false" - }, - "description": "Determines if the element is disabled. This sets the `aria-disabled`\nattribute accordingly, enabling support for all elements, including those\nthat don't support the native `disabled` attribute.\n\nThis feature can be combined with the\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled)\nprop to make disabled elements still accessible via keyboard.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Context Menu](https://ariakit.org/examples/menu-context-menu)", - "name": "disabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "finalFocus": { - "defaultValue": null, - "description": "Determines the element that will receive focus once the dialog is closed,\nprovided that no other element has been focused while the dialog was being\nhidden (e.g., by clicking or tabbing into another tabbable element outside\nof the dialog).\n- If\n [`autoFocusOnHide`](https://ariakit.org/reference/dialog#autofocusonhide)\n is set to `false`, this prop will have no effect.\n- If left unset, the element that was focused before the dialog was opened\n will be focused again.", - "name": "finalFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "fitViewport": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover should fit the viewport. If this is set to true, the\npopover wrapper will have `maxWidth` and `maxHeight` set to the viewport\nsize. This will be exposed to CSS as\n[`--popover-available-width`](https://ariakit.org/guide/styling#--popover-available-width)\nand\n[`--popover-available-height`](https://ariakit.org/guide/styling#--popover-available-height).\n\nLive examples:\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Menubar](https://ariakit.org/components/menubar)", - "name": "fitViewport", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "fixed": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover has `position: fixed` or not.", - "name": "fixed", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "flip": { - "defaultValue": { - "value": "true" - }, - "description": "Controls the behavior of the popover when it overflows the viewport:\n- If a `boolean`, specifies whether the popover should flip to the opposite\n side when it overflows.\n- If a `string`, indicates the preferred fallback placements when it\n overflows. The placements must be spaced-delimited, e.g. \"top left\".\n\nLive examples:\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Menubar](https://ariakit.org/components/menubar)", - "name": "flip", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "focusOnMove": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the active composite item should receive focus (or virtual\nfocus if the\n[`virtualFocus`](https://ariakit.org/reference/composite-provider#virtualfocus)\noption is enabled) when moving through items. This typically happens when\nnavigating through items with arrow keys, but it can also happen when\ncalling the\n[`move`](https://ariakit.org/reference/use-composite-store#move) method\ndirectly.\n\nUnlike the\n[`composite`](https://ariakit.org/reference/composite#composite-1) prop,\nthis option doesn't disable the entire composite widget behavior. It only\nstops this component from managing focus when navigating through items.\n\n**Note**: If you want to control the behavior only _when arrow keys are\npressed_, use the\n[`moveOnKeyPress`](https://ariakit.org/reference/composite#moveonkeypress)\nprop instead.", - "name": "focusOnMove", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "focusable": { - "defaultValue": null, - "description": "Determines if [Focusable](https://ariakit.org/components/focusable)\nfeatures should be active on non-native focusable elements.\n\n**Note**: This prop only turns off the additional features provided by the\n[`Focusable`](https://ariakit.org/reference/focusable) component.\nNon-native focusable elements will lose their focusability entirely.\nHowever, native focusable elements will retain their inherent focusability,\nbut without added features such as improved\n[`autoFocus`](https://ariakit.org/reference/focusable#autofocus),\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled),\n[`onFocusVisible`](https://ariakit.org/reference/focusable#onfocusvisible),\netc.\n@see https://ariakit.org/reference/focusable", - "name": "focusable", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "getAnchorRect": { - "defaultValue": null, - "description": "Function that returns the anchor element's DOMRect. If this is explicitly\npassed, it will override the anchor `getBoundingClientRect` method.\n\nLive examples:\n - [Textarea with inline combobox](https://ariakit.org/examples/combobox-textarea)\n - [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n - [Context menu](https://ariakit.org/examples/menu-context-menu)\n - [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "getAnchorRect", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "(anchor: HTMLElement) => AnchorRect" - } - }, - "getPersistentElements": { - "defaultValue": null, - "description": "When a dialog is open, the elements outside of it are disabled to prevent\ninteraction if the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). For non-modal\ndialogs, interacting with elements outside the dialog prompts it to close.\n\nThis function allows you to return an iterable collection of elements that\nwill be considered as part of the dialog, thus excluding them from this\nbehavior.\n\n**Note**: The elements returned by this function must exist in the DOM when\nthe dialog opens.\n\nLive examples:\n- [Dialog with\n React-Toastify](https://ariakit.org/examples/dialog-react-toastify)", - "name": "getPersistentElements", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "() => Iterable" - } - }, - "gutter": { - "defaultValue": { - "value": "xs" - }, - "description": "default 4px (space.xs)", - "name": "gutter", - "parent": { - "fileName": "lib/src/components/DropdownMenu/index.tsx", - "name": "DropdownMenuOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DropdownMenu/index.tsx", - "name": "DropdownMenuOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "keyof ThemeSpace", - "value": [ - { - "value": "string" - }, - { - "value": "number" - } - ] - } - }, - "hideOnEscape": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog will hide when the user presses the Escape key.\n\nThis prop can be either a boolean or a function that accepts an event as an\nargument and returns a boolean. The event object represents the keydown\nevent that initiated the hide action, which could be either a native\nkeyboard event or a React synthetic event.\n\n**Note**: When placing Ariakit dialogs inside third-party dialogs, using\n`event.stopPropagation()` within this function will stop the event from\nreaching the third-party dialog, closing only the Ariakit dialog.", - "name": "hideOnEscape", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: KeyboardEvent | React.KeyboardEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnHoverOutside": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the popover should hide when the mouse leaves the\npopover or the anchor element and there's no _hover intent_, meaning, the\nmouse isn't moving toward the popover.\n\nThis can be either a boolean or a callback receiving the mouse move event\nthat initiated the behavior. The callback should return a boolean.\n\n**Note**: This behavior won't be triggered when the popover or any of its\ndescendants are in focus.", - "name": "hideOnHoverOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: MouseEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnInteractOutside": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog should hide when the user clicks or focuses on an\nelement outside the dialog.\n\nThis prop can be either a boolean or a function that takes an event as an\nargument and returns a boolean. The event object represents the event that\ntriggered the action, which could be a native event or a React synthetic\nevent of various types.\n\nLive examples:\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "hideOnInteractOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: Event | SyntheticEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "initialFocus": { - "defaultValue": null, - "description": "Specifies the element that will receive focus when the dialog is first\nopened. It can be an `HTMLElement` or a `React.RefObject` with an\n`HTMLElement`.\n\nIf\n[`autoFocusOnShow`](https://ariakit.org/reference/dialog#autofocusonshow)\nis set to `false`, this prop will have no effect. If left unset, the dialog\nwill attempt to determine the initial focus element in the following order:\n1. A [Focusable](https://ariakit.org/components/focusable) element with an\n [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.\n2. The first tabbable element inside the dialog.\n3. The first focusable element inside the dialog.\n4. The dialog element itself.", - "name": "initialFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "innerProps": { - "defaultValue": { - "value": "{}" - }, - "description": "add custom props from styled system on DropdownMenu inner", - "name": "innerProps", - "parent": { - "fileName": "lib/src/components/DropdownMenu/index.tsx", - "name": "DropdownMenuOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DropdownMenu/index.tsx", - "name": "DropdownMenuOptions" - } - ], - "required": false, - "type": { - "name": "WuiProps" - } - }, - "modal": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the dialog is modal. Modal dialogs have distinct states\nand behaviors:\n- The [`portal`](https://ariakit.org/reference/dialog#portal) and\n [`preventBodyScroll`](https://ariakit.org/reference/dialog#preventbodyscroll)\n props are set to `true`. They can still be manually set to `false`.\n- When using the [`Heading`](https://ariakit.org/reference/heading) or\n [`DialogHeading`](https://ariakit.org/reference/dialog-heading)\n components within the dialog, their level will be reset so they start\n with `h1`.\n- A visually hidden dismiss button will be rendered if the\n [`DialogDismiss`](https://ariakit.org/reference/dialog-dismiss) component\n hasn't been used. This allows screen reader users to close the dialog.\n- When the dialog is open, element tree outside it will be inert.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Context menu](https://ariakit.org/examples/menu-context-menu)\n- [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "modal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "moveOnKeyPress": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the composite widget should move focus to an item when\narrow keys are pressed, given that the composite element is focused and\nthere's no active item.\n\n**Note**: To entirely disable focus moving within a composite widget, you\ncan use the\n[`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) prop\ninstead. If you want to control the behavior _only when arrow keys are\npressed_, where\n[`focusOnMove`](https://ariakit.org/reference/composite#focusonmove) may\nnot be applicable, this prop must be set on composite items as well.\n@example ```jsx\n\n \n \n\n```", - "name": "moveOnKeyPress", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite.d.ts", - "name": "CompositeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: KeyboardEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "onClose": { - "defaultValue": null, - "description": "This is an event handler prop triggered when the dialog's `close` event is\ndispatched. The `close` event is similar to the native dialog\n[`close`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/close_event)\nevent. The only difference is that this event can be canceled with\n`event.preventDefault()`, which will prevent the dialog from hiding.\n\nIt's important to note that this event only fires when the dialog store's\n[`open`](https://ariakit.org/reference/use-dialog-store#open) state is set\nto `false`. If the controlled\n[`open`](https://ariakit.org/reference/dialog#open) prop value changes, or\nif the dialog's visibility is altered in any other way (such as unmounting\nthe dialog without adjusting the open state), this event won't be\ntriggered.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "onClose", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "(event: Event) => void" - } - }, - "onFocusVisible": { - "defaultValue": null, - "description": "Custom event handler invoked when the element gains focus through keyboard\ninteraction or a key press occurs while the element is in focus. This is\nthe programmatic equivalent of the\n[`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible)\nattribute.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)", - "name": "onFocusVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(event: SyntheticEvent) => void>" - } - }, - "open": { - "defaultValue": null, - "description": "Controls the open state of the dialog. This is similar to the\n[`open`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/open)\nattribute on native dialog elements.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "open", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "overflowPadding": { - "defaultValue": { - "value": "8" - }, - "description": "The minimum padding between the popover and the viewport edge. This will be\nexposed to CSS as\n[`--popover-overflow-padding`](https://ariakit.org/guide/styling#--popover-overflow-padding).\n\nLive examples:\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)", - "name": "overflowPadding", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "overlap": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover can overlap the anchor element when it overflows.\n\nLive examples:\n- [Menubar](https://ariakit.org/components/menubar)\n- [Submenu with\n Combobox](https://ariakit.org/examples/menu-nested-combobox)", - "name": "overlap", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the element should be rendered as a React Portal.\n\nLive examples:\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Hovercard with keyboard\n support](https://ariakit.org/examples/hovercard-disclosure)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)", - "name": "portal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portalElement": { - "defaultValue": null, - "description": "An HTML element or a memoized callback function that returns an HTML\nelement to be used as the portal element. By default, the portal element\nwill be a `div` element appended to the `document.body`.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n@example ```jsx\nconst [portal, setPortal] = useState(null);\n\n\n
\n```\n@example ```jsx\nconst getPortalElement = useCallback(() => {\n const div = document.createElement(\"div\");\n const portalRoot = document.getElementById(\"portal-root\");\n portalRoot.appendChild(div);\n return div;\n}, []);\n\n\n```", - "name": "portalElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | ((element: HTMLElement) => HTMLElement)", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "(element: HTMLElement) => HTMLElement", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "portalRef": { - "defaultValue": null, - "description": "`portalRef` is similar to `ref` but is scoped to the portal node. It's\nuseful when you need to be informed when the portal element is appended to\nthe DOM or removed from the DOM.\n\nLive examples:\n- [Form with Select](https://ariakit.org/examples/form-select)\n@example ```jsx\nconst [portalElement, setPortalElement] = useState(null);\n\n\n```", - "name": "portalRef", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "RefCallback | MutableRefObject", - "value": [ - { - "value": "RefCallback", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "MutableRefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "preserveTabOrder": { - "defaultValue": { - "value": "false" - }, - "description": "When enabled, `preserveTabOrder` will keep the DOM element's tab order the\nsame as the order in which the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted in\nthe React tree.\n\nIf the\n[`preserveTabOrderAnchor`](https://ariakit.org/reference/portal#preservetaborderanchor)\nprop is provided, the tab order will be preserved relative to that element.", - "name": "preserveTabOrder", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "preserveTabOrderAnchor": { - "defaultValue": null, - "description": "An anchor element for maintaining the tab order when\n[`preserveTabOrder`](https://ariakit.org/reference/portal#preservetaborder)\nprop is enabled. The tab order will be kept relative to this element.\n\nBy default, the tab order is kept relative to the original location in the\nReact tree where the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted.\n@example ```jsx {18-20}\nconst [anchor, setAnchor] = useState(null);\n\n\n\n\n// Rendered at the end of the document.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved\n// relative to the anchor element.\n\n \n\n\n\n```", - "name": "preserveTabOrderAnchor", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "preventBodyScroll": { - "defaultValue": null, - "description": "Determines whether the body scrolling will be prevented when the dialog is\nshown. This is automatically set to `true` when the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). You can disable this\nprop if you want to implement your own logic.", - "name": "preventBodyScroll", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "render": { - "defaultValue": null, - "description": "Allows the component to be rendered as a different HTML element or React\ncomponent. The value can be a React element or a function that takes in the\noriginal component props and gives back a React element with the props\nmerged.\n\nCheck out the [Composition](https://ariakit.org/guide/composition) guide\nfor more details.", - "name": "render", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ReactElement> | RenderProp & { ref?: Ref; }>", - "value": [ - { - "value": "ReactElement>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "RenderProp & { ref?: Ref; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "sameWidth": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover should have the same width as the anchor element. This\nwill be exposed to CSS as\n[`--popover-anchor-width`](https://ariakit.org/guide/styling#--popover-anchor-width).", - "name": "sameWidth", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "shift": { - "defaultValue": { - "value": "0" - }, - "description": "The skidding of the popover along the anchor element. Can be set to\nnegative values to make the popover shift to the opposite side.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Select with Combobox and\n Tabs](https://ariakit.org/examples/select-combobox-tab)", - "name": "shift", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "slide": { - "defaultValue": { - "value": "true" - }, - "description": "Whether the popover should slide when it overflows.", - "name": "slide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "store": { - "defaultValue": null, - "description": "Object returned by the\n[`useMenuStore`](https://ariakit.org/reference/use-menu-store) hook. If not\nprovided, the closest\n[`MenuProvider`](https://ariakit.org/reference/menu-provider) component's\ncontext will be used.", - "name": "store", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-list.d.ts", - "name": "MenuListOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/menu/menu-list.d.ts", - "name": "MenuListOptions" - } - ], - "required": false, - "type": { - "name": "MenuStore" - } - }, - "typeahead": { - "defaultValue": { - "value": "true" - }, - "description": "When enabled, pressing printable character keys will move focus to the next\ncomposite item that starts with the entered characters.", - "name": "typeahead", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite-typeahead.d.ts", - "name": "CompositeTypeaheadOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite-typeahead.d.ts", - "name": "CompositeTypeaheadOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "unmountOnHide": { - "defaultValue": { - "value": "false" - }, - "description": "When set to `true`, the content element will be unmounted and removed from\nthe DOM when it's hidden.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)\n- [Multi-Select](https://ariakit.org/examples/select-multiple)", - "name": "unmountOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "unstable_treeSnapshotKey": { - "defaultValue": null, - "description": "@private", - "name": "unstable_treeSnapshotKey", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | number | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "updatePosition": { - "defaultValue": null, - "description": "A callback that will be called when the popover needs to calculate its\nposition. This will override the internal `updatePosition` function. The\noriginal `updatePosition` function will be passed as an argument, so it can\nbe called inside the callback to apply the default behavior.\n\nLive examples:\n - [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "updatePosition", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "(props: { updatePosition: () => Promise; }) => void | Promise" - } - }, - "wrapElement": { - "defaultValue": null, - "description": "", - "name": "wrapElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "WrapElement" - } - }, - "wrapperProps": { - "defaultValue": null, - "description": "Props that will be passed to the popover wrapper element. This element will\nbe used to position the popover.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)", - "name": "wrapperProps", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "HTMLAttributes" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Field/docs/properties.json b/lib/src/components/Field/docs/properties.json deleted file mode 100644 index 47c146696..000000000 --- a/lib/src/components/Field/docs/properties.json +++ /dev/null @@ -1,171 +0,0 @@ -{ - "Field": { - "props": { - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabledIcon": { - "defaultValue": null, - "description": "", - "name": "disabledIcon", - "parent": { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "hint": { - "defaultValue": null, - "description": "", - "name": "hint", - "parent": { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | Element", - "value": [ - { - "value": "string" - }, - { - "value": "Element", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "label": { - "defaultValue": null, - "description": "", - "name": "label", - "parent": { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | Element", - "value": [ - { - "value": "string" - }, - { - "value": "Element", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "required": { - "defaultValue": null, - "description": "", - "name": "required", - "parent": { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Field/index.tsx", - "name": "FieldOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/FileDrop/docs/properties.json b/lib/src/components/FileDrop/docs/properties.json deleted file mode 100644 index 3b7ede7bc..000000000 --- a/lib/src/components/FileDrop/docs/properties.json +++ /dev/null @@ -1,305 +0,0 @@ -{ - "FileDrop": { - "props": { - "accept": { - "defaultValue": { - "value": "{\n 'image/*': [],\n }" - }, - "description": "Pass a comma-separated string of file types e.g. \"image/png\" or \"image/png,image/jpeg\"", - "name": "accept", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - { - "fileName": "welcome-ui/node_modules/react-dropzone/typings/react-dropzone.d.ts", - "name": "TypeLiteral" - } - ], - "required": false, - "type": { - "name": "Accept" - } - }, - "fileName": { - "defaultValue": null, - "description": "", - "name": "fileName", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "forceFileType": { - "defaultValue": null, - "description": "", - "name": "forceFileType", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ForceFileType", - "value": [ - { - "value": "\"audio\"" - }, - { - "value": "\"video\"" - }, - { - "value": "\"image\"" - } - ] - } - }, - "handleAddFile": { - "defaultValue": null, - "description": "", - "name": "handleAddFile", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "(event: DropEvent | CreateEvent) => void" - } - }, - "handleRemoveFile": { - "defaultValue": null, - "description": "", - "name": "handleRemoveFile", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "(event: DropEvent | CreateEvent) => void" - } - }, - "isClearable": { - "defaultValue": null, - "description": "", - "name": "isClearable", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "isEditable": { - "defaultValue": null, - "description": "", - "name": "isEditable", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "(event: DropEvent | CreateEvent) => void" - } - }, - "onError": { - "defaultValue": null, - "description": "", - "name": "onError", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - { - "fileName": "welcome-ui/node_modules/react-dropzone/typings/react-dropzone.d.ts", - "name": "TypeLiteral" - } - ], - "required": false, - "type": { - "name": "((event?: string) => void) & ((err: Error) => void)" - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": true, - "type": { - "name": "enum", - "raw": "FileType", - "value": [ - { - "value": "string" - }, - { - "value": "FileWithPreview", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "wordings": { - "defaultValue": null, - "description": "Pass an object with optional fields title, hint, fileButtonText and/or previewButtonText (string or JSX.Element)", - "name": "wordings", - "parent": { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileDrop/index.tsx", - "name": "FileDropOptions" - } - ], - "required": false, - "type": { - "name": "WordingsType" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/FileUpload/docs/properties.json b/lib/src/components/FileUpload/docs/properties.json deleted file mode 100644 index ea035d615..000000000 --- a/lib/src/components/FileUpload/docs/properties.json +++ /dev/null @@ -1,143 +0,0 @@ -{ - "FileUpload": { - "props": { - "accept": { - "defaultValue": { - "value": "*/*" - }, - "description": "Pass a comma-separated string of file types e.g. \"image/png\" or \"image/png,image/jpeg\"", - "name": "accept", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "handleAddFile": { - "defaultValue": null, - "description": "", - "name": "handleAddFile", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "(files: FileWithPreviewType | FileWithPreviewType[]) => void" - } - }, - "handleRemoveFile": { - "defaultValue": null, - "description": "", - "name": "handleRemoveFile", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "HandleRemoveType" - } - }, - "maxSize": { - "defaultValue": { - "value": 2000000 - }, - "description": "", - "name": "maxSize", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "(event: { preventDefault: () => void; target: Record; }) => void" - } - }, - "preview": { - "defaultValue": null, - "description": "", - "name": "preview", - "parent": { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FileUpload/index.tsx", - "name": "FileUploadOptions" - } - ], - "required": false, - "type": { - "name": "FC" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Flex/docs/properties.json b/lib/src/components/Flex/docs/properties.json deleted file mode 100644 index 070cdd976..000000000 --- a/lib/src/components/Flex/docs/properties.json +++ /dev/null @@ -1,424 +0,0 @@ -{ - "Flex": { - "props": { - "align": { - "defaultValue": null, - "description": "same as alignItems", - "name": "align", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"center\"" - }, - { - "value": "\"end\"" - }, - { - "value": "\"flex-end\"" - }, - { - "value": "\"flex-start\"" - }, - { - "value": "\"self-end\"" - }, - { - "value": "\"self-start\"" - }, - { - "value": "\"start\"" - }, - { - "value": "\"baseline\"" - }, - { - "value": "\"normal\"" - }, - { - "value": "\"stretch\"" - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "basis": { - "defaultValue": null, - "description": "same as flexBasis", - "name": "basis", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "direction": { - "defaultValue": null, - "description": "same as flexDirection", - "name": "direction", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"row\"" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"column\"" - }, - { - "value": "\"column-reverse\"" - }, - { - "value": "\"row-reverse\"" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "grow": { - "defaultValue": null, - "description": "same as flexGrow", - "name": "grow", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "string & {}" - }, - { - "value": "number & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "justify": { - "defaultValue": null, - "description": "same as justifyContent", - "name": "justify", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"right\"" - }, - { - "value": "\"left\"" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"center\"" - }, - { - "value": "\"end\"" - }, - { - "value": "\"flex-end\"" - }, - { - "value": "\"flex-start\"" - }, - { - "value": "\"start\"" - }, - { - "value": "\"normal\"" - }, - { - "value": "\"stretch\"" - }, - { - "value": "string & {}" - }, - { - "value": "\"space-around\"" - }, - { - "value": "\"space-between\"" - }, - { - "value": "\"space-evenly\"" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "shrink": { - "defaultValue": null, - "description": "same as flexShrink", - "name": "shrink", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "string & {}" - }, - { - "value": "number & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "wrap": { - "defaultValue": null, - "description": "same as flexWrap", - "name": "wrap", - "parent": { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Flex/index.tsx", - "name": "FlexOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"wrap\"" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"nowrap\"" - }, - { - "value": "\"wrap-reverse\"" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Grid/docs/properties.json b/lib/src/components/Grid/docs/properties.json deleted file mode 100644 index d464683fe..000000000 --- a/lib/src/components/Grid/docs/properties.json +++ /dev/null @@ -1,648 +0,0 @@ -{ - "Grid": { - "props": { - "area": { - "defaultValue": null, - "description": "same as gridArea", - "name": "area", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"auto\"" - }, - { - "value": "string & {}" - }, - { - "value": "number & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoColumns": { - "defaultValue": null, - "description": "same as gridAutoColumns", - "name": "autoColumns", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp, Theme>", - "value": [ - { - "value": "0" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"auto\"" - }, - { - "value": "string & {}" - }, - { - "value": "\"max-content\"" - }, - { - "value": "\"min-content\"" - }, - { - "value": "ThemeProp, Theme>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoFlow": { - "defaultValue": null, - "description": "same as gridAutoFlow", - "name": "autoFlow", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"row\"" - }, - { - "value": "\"column\"" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "string & {}" - }, - { - "value": "\"dense\"" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoRows": { - "defaultValue": null, - "description": "same as gridAutoRows", - "name": "autoRows", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp, Theme>", - "value": [ - { - "value": "0" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"auto\"" - }, - { - "value": "string & {}" - }, - { - "value": "\"max-content\"" - }, - { - "value": "\"min-content\"" - }, - { - "value": "ThemeProp, Theme>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "column": { - "defaultValue": null, - "description": "same as gridColumn", - "name": "column", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"auto\"" - }, - { - "value": "string & {}" - }, - { - "value": "number & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "columnGap": { - "defaultValue": null, - "description": "same as columnGap", - "name": "columnGap", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "true" - }, - { - "value": "symbol" - }, - { - "value": "{}", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "gap": { - "defaultValue": null, - "description": "same as gridGap", - "name": "gap", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "true" - }, - { - "value": "symbol" - }, - { - "value": "{}", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "row": { - "defaultValue": null, - "description": "same as gridRow", - "name": "row", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"auto\"" - }, - { - "value": "string & {}" - }, - { - "value": "number & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "rowGap": { - "defaultValue": null, - "description": "same as gridRowGap", - "name": "rowGap", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "true" - }, - { - "value": "symbol" - }, - { - "value": "{}", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "templateAreas": { - "defaultValue": null, - "description": "same as gridTemplateAreas", - "name": "templateAreas", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "string & {}" - }, - { - "value": "\"none\"" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "templateColumns": { - "defaultValue": null, - "description": "same as gridTemplateColumns", - "name": "templateColumns", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "true" - }, - { - "value": "symbol" - }, - { - "value": "{}", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "templateRows": { - "defaultValue": null, - "description": "same as gridTemplateRows", - "name": "templateRows", - "parent": { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Grid/index.tsx", - "name": "GridOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SystemProp", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "true" - }, - { - "value": "symbol" - }, - { - "value": "{}", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "string & {}" - }, - { - "value": "ThemeProp", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Hint/docs/properties.json b/lib/src/components/Hint/docs/properties.json deleted file mode 100644 index 20bdf8578..000000000 --- a/lib/src/components/Hint/docs/properties.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "Hint": { - "props": { - "checkableField": { - "defaultValue": null, - "description": "", - "name": "checkableField", - "parent": { - "fileName": "lib/src/components/Hint/index.tsx", - "name": "HintOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Hint/index.tsx", - "name": "HintOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "variant": { - "defaultValue": null, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Hint/index.tsx", - "name": "HintOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Hint/index.tsx", - "name": "HintOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"danger\" | \"success\" | \"warning\"", - "value": [ - { - "value": "\"danger\"" - }, - { - "value": "\"success\"" - }, - { - "value": "\"warning\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Icon/docs/properties.json b/lib/src/components/Icon/docs/properties.json deleted file mode 100644 index eac1c0c21..000000000 --- a/lib/src/components/Icon/docs/properties.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "Icon": { - "props": { - "content": { - "defaultValue": null, - "description": "", - "name": "content", - "parent": { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "IconContent" - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onClick": { - "defaultValue": null, - "description": "", - "name": "onClick", - "parent": { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "(event: MouseEvent) => void" - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "string" - }, - { - "value": "number" - } - ] - } - }, - "title": { - "defaultValue": null, - "description": "", - "name": "title", - "parent": { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Icon/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/IconsFont/docs/properties.json b/lib/src/components/IconsFont/docs/properties.json deleted file mode 100644 index 94dd87468..000000000 --- a/lib/src/components/IconsFont/docs/properties.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "Icon": { - "props": { - "content": { - "defaultValue": null, - "description": "", - "name": "content", - "parent": { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "IconContent" - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onClick": { - "defaultValue": null, - "description": "", - "name": "onClick", - "parent": { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "(event: MouseEvent) => void" - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "string" - }, - { - "value": "number" - } - ] - } - }, - "title": { - "defaultValue": null, - "description": "", - "name": "title", - "parent": { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - }, - "declarations": [ - { - "fileName": "Icon/src/index.tsx", - "name": "IconOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/InputText/docs/properties.json b/lib/src/components/InputText/docs/properties.json deleted file mode 100644 index 6a175bf0d..000000000 --- a/lib/src/components/InputText/docs/properties.json +++ /dev/null @@ -1,321 +0,0 @@ -{ - "InputText": { - "props": { - "autoFocus": { - "defaultValue": null, - "description": "", - "name": "autoFocus", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "iconPlacement": { - "defaultValue": { - "value": "left" - }, - "description": "", - "name": "iconPlacement", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"right\" | \"left\"", - "value": [ - { - "value": "\"right\"" - }, - { - "value": "\"left\"" - } - ] - } - }, - "isClearable": { - "defaultValue": null, - "description": "", - "name": "isClearable", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: ChangeEvent) => void" - } - }, - "onFocus": { - "defaultValue": null, - "description": "", - "name": "onFocus", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onKeyDown": { - "defaultValue": null, - "description": "", - "name": "onKeyDown", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: KeyboardEvent) => void" - } - }, - "placeholder": { - "defaultValue": null, - "description": "", - "name": "placeholder", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "type": { - "defaultValue": { - "value": "text" - }, - "description": "", - "name": "type", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Label/docs/properties.json b/lib/src/components/Label/docs/properties.json deleted file mode 100644 index e8431565d..000000000 --- a/lib/src/components/Label/docs/properties.json +++ /dev/null @@ -1,208 +0,0 @@ -{ - "Label": { - "props": { - "checkableField": { - "defaultValue": null, - "description": "", - "name": "checkableField", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabledIcon": { - "defaultValue": null, - "description": "", - "name": "disabledIcon", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "htmlFor": { - "defaultValue": null, - "description": "", - "name": "htmlFor", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "required": { - "defaultValue": null, - "description": "", - "name": "required", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "variant": { - "defaultValue": null, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"success\" | \"danger\" | \"warning\"", - "value": [ - { - "value": "\"success\"" - }, - { - "value": "\"danger\"" - }, - { - "value": "\"warning\"" - } - ] - } - }, - "withDisabledIcon": { - "defaultValue": { - "value": true - }, - "description": "", - "name": "withDisabledIcon", - "parent": { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Label/index.tsx", - "name": "LabelOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Link/docs/properties.json b/lib/src/components/Link/docs/properties.json deleted file mode 100644 index 4021a4286..000000000 --- a/lib/src/components/Link/docs/properties.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "Link": { - "props": { - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Link/index.tsx", - "name": "LinkOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Link/index.tsx", - "name": "LinkOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "isExternal": { - "defaultValue": null, - "description": "", - "name": "isExternal", - "parent": { - "fileName": "lib/src/components/Link/index.tsx", - "name": "LinkOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Link/index.tsx", - "name": "LinkOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "target": { - "defaultValue": null, - "description": "", - "name": "target", - "parent": { - "fileName": "lib/src/components/UniversalLink/index.tsx", - "name": "UniversalLinkOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/UniversalLink/index.tsx", - "name": "UniversalLinkOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLAttributeAnchorTarget", - "value": [ - { - "value": "string & {}" - }, - { - "value": "\"_self\"" - }, - { - "value": "\"_blank\"" - }, - { - "value": "\"_parent\"" - }, - { - "value": "\"_top\"" - } - ] - } - }, - "variant": { - "defaultValue": null, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Link/index.tsx", - "name": "LinkOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Link/index.tsx", - "name": "LinkOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Variant", - "value": [ - { - "value": "\"primary\"" - }, - { - "value": "\"secondary\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Loader/docs/properties.json b/lib/src/components/Loader/docs/properties.json deleted file mode 100644 index cabca8884..000000000 --- a/lib/src/components/Loader/docs/properties.json +++ /dev/null @@ -1,613 +0,0 @@ -{ - "Loader": { - "props": { - "color": { - "defaultValue": null, - "description": "", - "name": "color", - "parent": { - "fileName": "lib/src/components/Loader/index.tsx", - "name": "LoaderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Loader/index.tsx", - "name": "LoaderOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Color", - "value": [ - { - "value": "string & {}" - }, - { - "value": "\"-moz-initial\"" - }, - { - "value": "\"inherit\"" - }, - { - "value": "\"initial\"" - }, - { - "value": "\"revert\"" - }, - { - "value": "\"revert-layer\"" - }, - { - "value": "\"unset\"" - }, - { - "value": "\"aliceblue\"" - }, - { - "value": "\"antiquewhite\"" - }, - { - "value": "\"aqua\"" - }, - { - "value": "\"aquamarine\"" - }, - { - "value": "\"azure\"" - }, - { - "value": "\"beige\"" - }, - { - "value": "\"bisque\"" - }, - { - "value": "\"black\"" - }, - { - "value": "\"blanchedalmond\"" - }, - { - "value": "\"blue\"" - }, - { - "value": "\"blueviolet\"" - }, - { - "value": "\"brown\"" - }, - { - "value": "\"burlywood\"" - }, - { - "value": "\"cadetblue\"" - }, - { - "value": "\"chartreuse\"" - }, - { - "value": "\"chocolate\"" - }, - { - "value": "\"coral\"" - }, - { - "value": "\"cornflowerblue\"" - }, - { - "value": "\"cornsilk\"" - }, - { - "value": "\"crimson\"" - }, - { - "value": "\"cyan\"" - }, - { - "value": "\"darkblue\"" - }, - { - "value": "\"darkcyan\"" - }, - { - "value": "\"darkgoldenrod\"" - }, - { - "value": "\"darkgray\"" - }, - { - "value": "\"darkgreen\"" - }, - { - "value": "\"darkgrey\"" - }, - { - "value": "\"darkkhaki\"" - }, - { - "value": "\"darkmagenta\"" - }, - { - "value": "\"darkolivegreen\"" - }, - { - "value": "\"darkorange\"" - }, - { - "value": "\"darkorchid\"" - }, - { - "value": "\"darkred\"" - }, - { - "value": "\"darksalmon\"" - }, - { - "value": "\"darkseagreen\"" - }, - { - "value": "\"darkslateblue\"" - }, - { - "value": "\"darkslategray\"" - }, - { - "value": "\"darkslategrey\"" - }, - { - "value": "\"darkturquoise\"" - }, - { - "value": "\"darkviolet\"" - }, - { - "value": "\"deeppink\"" - }, - { - "value": "\"deepskyblue\"" - }, - { - "value": "\"dimgray\"" - }, - { - "value": "\"dimgrey\"" - }, - { - "value": "\"dodgerblue\"" - }, - { - "value": "\"firebrick\"" - }, - { - "value": "\"floralwhite\"" - }, - { - "value": "\"forestgreen\"" - }, - { - "value": "\"fuchsia\"" - }, - { - "value": "\"gainsboro\"" - }, - { - "value": "\"ghostwhite\"" - }, - { - "value": "\"gold\"" - }, - { - "value": "\"goldenrod\"" - }, - { - "value": "\"gray\"" - }, - { - "value": "\"green\"" - }, - { - "value": "\"greenyellow\"" - }, - { - "value": "\"grey\"" - }, - { - "value": "\"honeydew\"" - }, - { - "value": "\"hotpink\"" - }, - { - "value": "\"indianred\"" - }, - { - "value": "\"indigo\"" - }, - { - "value": "\"ivory\"" - }, - { - "value": "\"khaki\"" - }, - { - "value": "\"lavender\"" - }, - { - "value": "\"lavenderblush\"" - }, - { - "value": "\"lawngreen\"" - }, - { - "value": "\"lemonchiffon\"" - }, - { - "value": "\"lightblue\"" - }, - { - "value": "\"lightcoral\"" - }, - { - "value": "\"lightcyan\"" - }, - { - "value": "\"lightgoldenrodyellow\"" - }, - { - "value": "\"lightgray\"" - }, - { - "value": "\"lightgreen\"" - }, - { - "value": "\"lightgrey\"" - }, - { - "value": "\"lightpink\"" - }, - { - "value": "\"lightsalmon\"" - }, - { - "value": "\"lightseagreen\"" - }, - { - "value": "\"lightskyblue\"" - }, - { - "value": "\"lightslategray\"" - }, - { - "value": "\"lightslategrey\"" - }, - { - "value": "\"lightsteelblue\"" - }, - { - "value": "\"lightyellow\"" - }, - { - "value": "\"lime\"" - }, - { - "value": "\"limegreen\"" - }, - { - "value": "\"linen\"" - }, - { - "value": "\"magenta\"" - }, - { - "value": "\"maroon\"" - }, - { - "value": "\"mediumaquamarine\"" - }, - { - "value": "\"mediumblue\"" - }, - { - "value": "\"mediumorchid\"" - }, - { - "value": "\"mediumpurple\"" - }, - { - "value": "\"mediumseagreen\"" - }, - { - "value": "\"mediumslateblue\"" - }, - { - "value": "\"mediumspringgreen\"" - }, - { - "value": "\"mediumturquoise\"" - }, - { - "value": "\"mediumvioletred\"" - }, - { - "value": "\"midnightblue\"" - }, - { - "value": "\"mintcream\"" - }, - { - "value": "\"mistyrose\"" - }, - { - "value": "\"moccasin\"" - }, - { - "value": "\"navajowhite\"" - }, - { - "value": "\"navy\"" - }, - { - "value": "\"oldlace\"" - }, - { - "value": "\"olive\"" - }, - { - "value": "\"olivedrab\"" - }, - { - "value": "\"orange\"" - }, - { - "value": "\"orangered\"" - }, - { - "value": "\"orchid\"" - }, - { - "value": "\"palegoldenrod\"" - }, - { - "value": "\"palegreen\"" - }, - { - "value": "\"paleturquoise\"" - }, - { - "value": "\"palevioletred\"" - }, - { - "value": "\"papayawhip\"" - }, - { - "value": "\"peachpuff\"" - }, - { - "value": "\"peru\"" - }, - { - "value": "\"pink\"" - }, - { - "value": "\"plum\"" - }, - { - "value": "\"powderblue\"" - }, - { - "value": "\"purple\"" - }, - { - "value": "\"rebeccapurple\"" - }, - { - "value": "\"red\"" - }, - { - "value": "\"rosybrown\"" - }, - { - "value": "\"royalblue\"" - }, - { - "value": "\"saddlebrown\"" - }, - { - "value": "\"salmon\"" - }, - { - "value": "\"sandybrown\"" - }, - { - "value": "\"seagreen\"" - }, - { - "value": "\"seashell\"" - }, - { - "value": "\"sienna\"" - }, - { - "value": "\"silver\"" - }, - { - "value": "\"skyblue\"" - }, - { - "value": "\"slateblue\"" - }, - { - "value": "\"slategray\"" - }, - { - "value": "\"slategrey\"" - }, - { - "value": "\"snow\"" - }, - { - "value": "\"springgreen\"" - }, - { - "value": "\"steelblue\"" - }, - { - "value": "\"tan\"" - }, - { - "value": "\"teal\"" - }, - { - "value": "\"thistle\"" - }, - { - "value": "\"tomato\"" - }, - { - "value": "\"transparent\"" - }, - { - "value": "\"turquoise\"" - }, - { - "value": "\"violet\"" - }, - { - "value": "\"wheat\"" - }, - { - "value": "\"white\"" - }, - { - "value": "\"whitesmoke\"" - }, - { - "value": "\"yellow\"" - }, - { - "value": "\"yellowgreen\"" - }, - { - "value": "\"ActiveBorder\"" - }, - { - "value": "\"ActiveCaption\"" - }, - { - "value": "\"AppWorkspace\"" - }, - { - "value": "\"Background\"" - }, - { - "value": "\"ButtonFace\"" - }, - { - "value": "\"ButtonHighlight\"" - }, - { - "value": "\"ButtonShadow\"" - }, - { - "value": "\"ButtonText\"" - }, - { - "value": "\"CaptionText\"" - }, - { - "value": "\"GrayText\"" - }, - { - "value": "\"Highlight\"" - }, - { - "value": "\"HighlightText\"" - }, - { - "value": "\"InactiveBorder\"" - }, - { - "value": "\"InactiveCaption\"" - }, - { - "value": "\"InactiveCaptionText\"" - }, - { - "value": "\"InfoBackground\"" - }, - { - "value": "\"InfoText\"" - }, - { - "value": "\"Menu\"" - }, - { - "value": "\"MenuText\"" - }, - { - "value": "\"Scrollbar\"" - }, - { - "value": "\"ThreeDDarkShadow\"" - }, - { - "value": "\"ThreeDFace\"" - }, - { - "value": "\"ThreeDHighlight\"" - }, - { - "value": "\"ThreeDLightShadow\"" - }, - { - "value": "\"ThreeDShadow\"" - }, - { - "value": "\"Window\"" - }, - { - "value": "\"WindowFrame\"" - }, - { - "value": "\"WindowText\"" - }, - { - "value": "\"currentcolor\"" - } - ] - } - }, - "size": { - "defaultValue": { - "value": "sm" - }, - "description": "Predefined size xs, sm, md, lg or custom size", - "name": "size", - "parent": { - "fileName": "lib/src/components/Loader/index.tsx", - "name": "LoaderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Loader/index.tsx", - "name": "LoaderOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "string" - }, - { - "value": "number" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Logo/docs/properties.json b/lib/src/components/Logo/docs/properties.json deleted file mode 100644 index 6eb03393c..000000000 --- a/lib/src/components/Logo/docs/properties.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "SolutionsSymbol": { - "props": {} - }, - "Symbol": { - "props": {} - }, - "Welcome": { - "props": {} - }, - "WelcomeUI": { - "props": {} - } -} \ No newline at end of file diff --git a/lib/src/components/Modal/docs/properties.json b/lib/src/components/Modal/docs/properties.json deleted file mode 100644 index e2b9d6327..000000000 --- a/lib/src/components/Modal/docs/properties.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "Body": { - "props": { - "animated": { - "defaultValue": null, - "description": "Determines whether the content should animate when it is shown or hidden.\n- If `true`, the `animating` state will be `true` when the content is shown\n or hidden and it will wait for a CSS animation/transition to end before\n becoming `false`.\n- If it's set to a number, the `animating` state will be `true` when the\n content is shown or hidden and it will wait for the number of\n milliseconds to pass before becoming `false`.\n@deprecated Manually setting the `animated` prop is no longer necessary.\nThis will be removed in a future release.", - "name": "animated", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "number | boolean", - "value": [ - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "defaultOpen": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the content should be visible by default.", - "name": "defaultOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disclosure": { - "defaultValue": null, - "description": "A reference to another disclosure store that controls another disclosure\ncomponent to keep them in sync. Element states like `contentElement` and\n`disclosureElement` won't be synced. For that, use the\n[`store`](https://ariakit.org/reference/disclosure-provider#store) prop\ninstead.\n\nLive examples:\n- [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)", - "name": "disclosure", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "DisclosureStore" - } - }, - "setMounted": { - "defaultValue": null, - "description": "A callback that gets called when the `mounted` state changes.\n@example const [mounted, setMounted] = useState(false);\nconst disclosure = useDisclosureStore({ setMounted });", - "name": "setMounted", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(mounted: boolean) => void" - } - }, - "setOpen": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state\nchanges.\n@example const [open, setOpen] = useState(false);\nconst disclosure = useDisclosureStore({ open, setOpen });", - "name": "setOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(open: boolean) => void" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Pagination/docs/properties.json b/lib/src/components/Pagination/docs/properties.json deleted file mode 100644 index fffa177d7..000000000 --- a/lib/src/components/Pagination/docs/properties.json +++ /dev/null @@ -1,160 +0,0 @@ -{ - "Pagination": { - "props": { - "aria-label": { - "defaultValue": null, - "description": "", - "name": "aria-label", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": true, - "type": { - "name": "string" - } - }, - "getHref": { - "defaultValue": null, - "description": "", - "name": "getHref", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": false, - "type": { - "name": "(page: string | number) => string" - } - }, - "leftArrow": { - "defaultValue": null, - "description": "", - "name": "leftArrow", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": true, - "type": { - "name": "(page: string | number) => void" - } - }, - "page": { - "defaultValue": null, - "description": "", - "name": "page", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": true, - "type": { - "name": "number" - } - }, - "pageCount": { - "defaultValue": null, - "description": "", - "name": "pageCount", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": true, - "type": { - "name": "number" - } - }, - "rangeDisplay": { - "defaultValue": { - "value": 5 - }, - "description": "", - "name": "rangeDisplay", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "rightArrow": { - "defaultValue": null, - "description": "", - "name": "rightArrow", - "parent": { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Pagination/index.tsx", - "name": "PaginationOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/PasswordInput/docs/properties.json b/lib/src/components/PasswordInput/docs/properties.json deleted file mode 100644 index b9d3c92f4..000000000 --- a/lib/src/components/PasswordInput/docs/properties.json +++ /dev/null @@ -1,317 +0,0 @@ -{ - "PasswordInput": { - "props": { - "autoFocus": { - "defaultValue": null, - "description": "", - "name": "autoFocus", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "iconPlacement": { - "defaultValue": null, - "description": "", - "name": "iconPlacement", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"right\" | \"left\"", - "value": [ - { - "value": "\"right\"" - }, - { - "value": "\"left\"" - } - ] - } - }, - "isClearable": { - "defaultValue": null, - "description": "", - "name": "isClearable", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: ChangeEvent) => void" - } - }, - "onFocus": { - "defaultValue": null, - "description": "", - "name": "onFocus", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onKeyDown": { - "defaultValue": null, - "description": "", - "name": "onKeyDown", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "(event: KeyboardEvent) => void" - } - }, - "placeholder": { - "defaultValue": null, - "description": "", - "name": "placeholder", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "type": { - "defaultValue": null, - "description": "", - "name": "type", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/InputText/index.tsx", - "name": "InputTextOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Picker/docs/properties.json b/lib/src/components/Picker/docs/properties.json deleted file mode 100644 index bc46800ba..000000000 --- a/lib/src/components/Picker/docs/properties.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "Picker": { - "props": { - "label": { - "defaultValue": null, - "description": "", - "name": "label", - "parent": { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - } - ], - "required": false, - "type": { - "name": "MouseEventHandler" - } - }, - "options": { - "defaultValue": null, - "description": "", - "name": "options", - "parent": { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - } - ], - "required": false, - "type": { - "name": "PickerOption[]" - } - }, - "required": { - "defaultValue": null, - "description": "", - "name": "required", - "parent": { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Picker/index.tsx", - "name": "PickerOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Popover/docs/properties.json b/lib/src/components/Popover/docs/properties.json deleted file mode 100644 index 03f495a13..000000000 --- a/lib/src/components/Popover/docs/properties.json +++ /dev/null @@ -1,3016 +0,0 @@ -{ - "Popover": { - "props": { - "accessibleWhenDisabled": { - "defaultValue": null, - "description": "Indicates whether the element should be focusable even when it is\n[`disabled`](https://ariakit.org/reference/focusable#disabled).\n\nThis is important when discoverability is a concern. For example:\n\n> A toolbar in an editor contains a set of special smart paste functions\nthat are disabled when the clipboard is empty or when the function is not\napplicable to the current content of the clipboard. It could be helpful to\nkeep the disabled buttons focusable if the ability to discover their\nfunctionality is primarily via their presence on the toolbar.\n\nLearn more on [Focusability of disabled\ncontrols](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "accessibleWhenDisabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "alwaysVisible": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the content element should remain visible even when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state is\n`false`. If this prop is set to `true`, the `hidden` prop and the `display:\nnone` style will not be applied, unless explicitly set otherwise.\n\nThis prop is particularly useful when using third-party animation libraries\nsuch as Framer Motion or React Spring, where the element needs to be\nvisible for exit animations to work.\n\nLive examples:\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Menu with Framer\n Motion](https://ariakit.org/examples/menu-framer-motion)\n- [Tooltip with Framer\n Motion](https://ariakit.org/examples/tooltip-framer-motion)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)", - "name": "alwaysVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "arrowPadding": { - "defaultValue": { - "value": "4" - }, - "description": "The minimum padding between the arrow and the popover corner.", - "name": "arrowPadding", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "autoFocus": { - "defaultValue": { - "value": "false" - }, - "description": "Automatically focuses the element upon mounting, similar to the native\n`autoFocus` prop. This addresses an issue where the element with the native\n`autoFocus` attribute might receive focus before React effects are\nexecuted.\n\nThe `autoFocus` prop can also be used with\n[Focusable](https://ariakit.org/components/focusable) elements within a\n[Dialog](https://ariakit.org/components/dialog) component, establishing the\ninitial focus as the dialog opens.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with React\n Router](https://ariakit.org/examples/dialog-react-router)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)", - "name": "autoFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocusOnHide": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element outside of the dialog will be focused when\nthe dialog is hidden if another element hasn't been focused in the action\nof hiding the dialog (for example, by clicking or tabbing into another\ntabbable element outside of the dialog).\n\nBy default, this is usually the disclosure element. The\n[`finalFocus`](https://ariakit.org/reference/dialog#finalfocus) prop can be\nused to define a different element to be focused.\n\nLive examples:\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n- [Sliding menu](https://ariakit.org/examples/menu-slide)", - "name": "autoFocusOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoFocusOnShow": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element inside the dialog will receive focus when the\ndialog is shown. By default, this is usually the first tabbable element in\nthe dialog or the dialog itself. The\n[`initialFocus`](https://ariakit.org/reference/dialog#initialfocus) prop\ncan be used to set a different element to receive focus.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "autoFocusOnShow", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "backdrop": { - "defaultValue": null, - "description": "Determines whether there will be a backdrop behind the dialog. On modal\ndialogs, this is `true` by default. Besides a `boolean`, this prop can also\nbe a React component or JSX element that will be rendered as the backdrop.\n\n**Note**: If a custom component is used, it must [accept ref and spread all\nprops to its underlying DOM\nelement](https://ariakit.org/guide/composition#custom-components-must-be-open-for-extension),\nthe same way a native element would.\n\nLive examples:\n- [Animated Dialog](https://ariakit.org/examples/dialog-animated)\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n@example ```jsx\n} />\n```", - "name": "backdrop", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean | ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes<...>> & { ...; }, string | JSXElementConstructor<...>> | ElementType<...>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, string | JSXElementConstructor<...>>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ComponentClass, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, any>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "disabled": { - "defaultValue": { - "value": "false" - }, - "description": "Determines if the element is disabled. This sets the `aria-disabled`\nattribute accordingly, enabling support for all elements, including those\nthat don't support the native `disabled` attribute.\n\nThis feature can be combined with the\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled)\nprop to make disabled elements still accessible via keyboard.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Context Menu](https://ariakit.org/examples/menu-context-menu)", - "name": "disabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "finalFocus": { - "defaultValue": null, - "description": "Determines the element that will receive focus once the dialog is closed,\nprovided that no other element has been focused while the dialog was being\nhidden (e.g., by clicking or tabbing into another tabbable element outside\nof the dialog).\n- If\n [`autoFocusOnHide`](https://ariakit.org/reference/dialog#autofocusonhide)\n is set to `false`, this prop will have no effect.\n- If left unset, the element that was focused before the dialog was opened\n will be focused again.", - "name": "finalFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "fitViewport": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover should fit the viewport. If this is set to true, the\npopover wrapper will have `maxWidth` and `maxHeight` set to the viewport\nsize. This will be exposed to CSS as\n[`--popover-available-width`](https://ariakit.org/guide/styling#--popover-available-width)\nand\n[`--popover-available-height`](https://ariakit.org/guide/styling#--popover-available-height).\n\nLive examples:\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Menubar](https://ariakit.org/components/menubar)", - "name": "fitViewport", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "fixed": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover has `position: fixed` or not.", - "name": "fixed", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "flip": { - "defaultValue": { - "value": "true" - }, - "description": "Controls the behavior of the popover when it overflows the viewport:\n- If a `boolean`, specifies whether the popover should flip to the opposite\n side when it overflows.\n- If a `string`, indicates the preferred fallback placements when it\n overflows. The placements must be spaced-delimited, e.g. \"top left\".\n\nLive examples:\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Menubar](https://ariakit.org/components/menubar)", - "name": "flip", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "focusable": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if [Focusable](https://ariakit.org/components/focusable)\nfeatures should be active on non-native focusable elements.\n\n**Note**: This prop only turns off the additional features provided by the\n[`Focusable`](https://ariakit.org/reference/focusable) component.\nNon-native focusable elements will lose their focusability entirely.\nHowever, native focusable elements will retain their inherent focusability,\nbut without added features such as improved\n[`autoFocus`](https://ariakit.org/reference/focusable#autofocus),\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled),\n[`onFocusVisible`](https://ariakit.org/reference/focusable#onfocusvisible),\netc.", - "name": "focusable", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "getAnchorRect": { - "defaultValue": null, - "description": "Function that returns the anchor element's DOMRect. If this is explicitly\npassed, it will override the anchor `getBoundingClientRect` method.\n\nLive examples:\n - [Textarea with inline combobox](https://ariakit.org/examples/combobox-textarea)\n - [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n - [Context menu](https://ariakit.org/examples/menu-context-menu)\n - [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "getAnchorRect", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "(anchor: HTMLElement) => AnchorRect" - } - }, - "getPersistentElements": { - "defaultValue": null, - "description": "When a dialog is open, the elements outside of it are disabled to prevent\ninteraction if the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). For non-modal\ndialogs, interacting with elements outside the dialog prompts it to close.\n\nThis function allows you to return an iterable collection of elements that\nwill be considered as part of the dialog, thus excluding them from this\nbehavior.\n\n**Note**: The elements returned by this function must exist in the DOM when\nthe dialog opens.\n\nLive examples:\n- [Dialog with\n React-Toastify](https://ariakit.org/examples/dialog-react-toastify)", - "name": "getPersistentElements", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "() => Iterable" - } - }, - "gutter": { - "defaultValue": { - "value": "0" - }, - "description": "The distance between the popover and the anchor element.\n\nLive examples:\n- [Combobox filtering](https://ariakit.org/examples/combobox-filtering)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Hovercard with keyboard support](https://ariakit.org/examples/hovercard-disclosure)\n- [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Toolbar with Select](https://ariakit.org/examples/toolbar-select)", - "name": "gutter", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "hideOnEscape": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog will hide when the user presses the Escape key.\n\nThis prop can be either a boolean or a function that accepts an event as an\nargument and returns a boolean. The event object represents the keydown\nevent that initiated the hide action, which could be either a native\nkeyboard event or a React synthetic event.\n\n**Note**: When placing Ariakit dialogs inside third-party dialogs, using\n`event.stopPropagation()` within this function will stop the event from\nreaching the third-party dialog, closing only the Ariakit dialog.", - "name": "hideOnEscape", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: KeyboardEvent | React.KeyboardEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnInteractOutside": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog should hide when the user clicks or focuses on an\nelement outside the dialog.\n\nThis prop can be either a boolean or a function that takes an event as an\nargument and returns a boolean. The event object represents the event that\ntriggered the action, which could be a native event or a React synthetic\nevent of various types.\n\nLive examples:\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "hideOnInteractOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: Event | SyntheticEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "initialFocus": { - "defaultValue": null, - "description": "Specifies the element that will receive focus when the dialog is first\nopened. It can be an `HTMLElement` or a `React.RefObject` with an\n`HTMLElement`.\n\nIf\n[`autoFocusOnShow`](https://ariakit.org/reference/dialog#autofocusonshow)\nis set to `false`, this prop will have no effect. If left unset, the dialog\nwill attempt to determine the initial focus element in the following order:\n1. A [Focusable](https://ariakit.org/components/focusable) element with an\n [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.\n2. The first tabbable element inside the dialog.\n3. The first focusable element inside the dialog.\n4. The dialog element itself.", - "name": "initialFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "modal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the dialog is modal. Modal dialogs have distinct states\nand behaviors:\n- The [`portal`](https://ariakit.org/reference/dialog#portal) and\n [`preventBodyScroll`](https://ariakit.org/reference/dialog#preventbodyscroll)\n props are set to `true`. They can still be manually set to `false`.\n- When using the [`Heading`](https://ariakit.org/reference/heading) or\n [`DialogHeading`](https://ariakit.org/reference/dialog-heading)\n components within the dialog, their level will be reset so they start\n with `h1`.\n- A visually hidden dismiss button will be rendered if the\n [`DialogDismiss`](https://ariakit.org/reference/dialog-dismiss) component\n hasn't been used. This allows screen reader users to close the dialog.\n- When the dialog is open, element tree outside it will be inert.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Context menu](https://ariakit.org/examples/menu-context-menu)\n- [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "modal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "onClose": { - "defaultValue": null, - "description": "call a function when popover closed", - "name": "onClose", - "parent": { - "fileName": "lib/src/components/Popover/Popover.tsx", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Popover/Popover.tsx", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "onFocusVisible": { - "defaultValue": null, - "description": "Custom event handler invoked when the element gains focus through keyboard\ninteraction or a key press occurs while the element is in focus. This is\nthe programmatic equivalent of the\n[`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible)\nattribute.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)", - "name": "onFocusVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(event: SyntheticEvent) => void>" - } - }, - "open": { - "defaultValue": null, - "description": "Controls the open state of the dialog. This is similar to the\n[`open`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/open)\nattribute on native dialog elements.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "open", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "overflowPadding": { - "defaultValue": { - "value": "8" - }, - "description": "The minimum padding between the popover and the viewport edge. This will be\nexposed to CSS as\n[`--popover-overflow-padding`](https://ariakit.org/guide/styling#--popover-overflow-padding).\n\nLive examples:\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)", - "name": "overflowPadding", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "overlap": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover can overlap the anchor element when it overflows.\n\nLive examples:\n- [Menubar](https://ariakit.org/components/menubar)\n- [Submenu with\n Combobox](https://ariakit.org/examples/menu-nested-combobox)", - "name": "overlap", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the element should be rendered as a React Portal.\n\nLive examples:\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Hovercard with keyboard\n support](https://ariakit.org/examples/hovercard-disclosure)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)", - "name": "portal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portalElement": { - "defaultValue": null, - "description": "An HTML element or a memoized callback function that returns an HTML\nelement to be used as the portal element. By default, the portal element\nwill be a `div` element appended to the `document.body`.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n@example ```jsx\nconst [portal, setPortal] = useState(null);\n\n\n
\n```\n@example ```jsx\nconst getPortalElement = useCallback(() => {\n const div = document.createElement(\"div\");\n const portalRoot = document.getElementById(\"portal-root\");\n portalRoot.appendChild(div);\n return div;\n}, []);\n\n\n```", - "name": "portalElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | ((element: HTMLElement) => HTMLElement)", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "(element: HTMLElement) => HTMLElement", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "portalRef": { - "defaultValue": null, - "description": "`portalRef` is similar to `ref` but is scoped to the portal node. It's\nuseful when you need to be informed when the portal element is appended to\nthe DOM or removed from the DOM.\n\nLive examples:\n- [Form with Select](https://ariakit.org/examples/form-select)\n@example ```jsx\nconst [portalElement, setPortalElement] = useState(null);\n\n\n```", - "name": "portalRef", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "RefCallback | MutableRefObject", - "value": [ - { - "value": "RefCallback", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "MutableRefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "preserveTabOrder": { - "defaultValue": { - "value": "false" - }, - "description": "When enabled, `preserveTabOrder` will keep the DOM element's tab order the\nsame as the order in which the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted in\nthe React tree.\n\nIf the\n[`preserveTabOrderAnchor`](https://ariakit.org/reference/portal#preservetaborderanchor)\nprop is provided, the tab order will be preserved relative to that element.", - "name": "preserveTabOrder", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "preserveTabOrderAnchor": { - "defaultValue": null, - "description": "An anchor element for maintaining the tab order when\n[`preserveTabOrder`](https://ariakit.org/reference/portal#preservetaborder)\nprop is enabled. The tab order will be kept relative to this element.\n\nBy default, the tab order is kept relative to the original location in the\nReact tree where the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted.\n@example ```jsx {18-20}\nconst [anchor, setAnchor] = useState(null);\n\n\n\n\n// Rendered at the end of the document.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved\n// relative to the anchor element.\n\n \n\n\n\n```", - "name": "preserveTabOrderAnchor", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "preventBodyScroll": { - "defaultValue": null, - "description": "Determines whether the body scrolling will be prevented when the dialog is\nshown. This is automatically set to `true` when the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). You can disable this\nprop if you want to implement your own logic.", - "name": "preventBodyScroll", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "render": { - "defaultValue": null, - "description": "Allows the component to be rendered as a different HTML element or React\ncomponent. The value can be a React element or a function that takes in the\noriginal component props and gives back a React element with the props\nmerged.\n\nCheck out the [Composition](https://ariakit.org/guide/composition) guide\nfor more details.", - "name": "render", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ReactElement> | RenderProp & { ref?: Ref; }>", - "value": [ - { - "value": "ReactElement>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "RenderProp & { ref?: Ref; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "sameWidth": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover should have the same width as the anchor element. This\nwill be exposed to CSS as\n[`--popover-anchor-width`](https://ariakit.org/guide/styling#--popover-anchor-width).", - "name": "sameWidth", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "shift": { - "defaultValue": { - "value": "0" - }, - "description": "The skidding of the popover along the anchor element. Can be set to\nnegative values to make the popover shift to the opposite side.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Select with Combobox and\n Tabs](https://ariakit.org/examples/select-combobox-tab)", - "name": "shift", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "slide": { - "defaultValue": { - "value": "true" - }, - "description": "Whether the popover should slide when it overflows.", - "name": "slide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "store": { - "defaultValue": null, - "description": "Object returned by the\n[`usePopoverStore`](https://ariakit.org/reference/use-popover-store) hook.\nIf not provided, the closest\n[`PopoverProvider`](https://ariakit.org/reference/popover-provider)\ncomponent's context will be used.", - "name": "store", - "parent": { - "fileName": "lib/src/components/Popover/Popover.tsx", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Popover/Popover.tsx", - "name": "PopoverOptions" - } - ], - "required": true, - "type": { - "name": "PopoverStore & Pick" - } - }, - "unmountOnHide": { - "defaultValue": { - "value": "false" - }, - "description": "When set to `true`, the content element will be unmounted and removed from\nthe DOM when it's hidden.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)\n- [Multi-Select](https://ariakit.org/examples/select-multiple)", - "name": "unmountOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "unstable_treeSnapshotKey": { - "defaultValue": null, - "description": "@private", - "name": "unstable_treeSnapshotKey", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | number | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "updatePosition": { - "defaultValue": null, - "description": "A callback that will be called when the popover needs to calculate its\nposition. This will override the internal `updatePosition` function. The\noriginal `updatePosition` function will be passed as an argument, so it can\nbe called inside the callback to apply the default behavior.\n\nLive examples:\n - [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "updatePosition", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "(props: { updatePosition: () => Promise; }) => void | Promise" - } - }, - "wrapElement": { - "defaultValue": null, - "description": "", - "name": "wrapElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "WrapElement" - } - }, - "wrapperProps": { - "defaultValue": null, - "description": "Props that will be passed to the popover wrapper element. This element will\nbe used to position the popover.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)", - "name": "wrapperProps", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "HTMLAttributes" - } - } - } - }, - "PopoverHover": { - "props": { - "accessibleWhenDisabled": { - "defaultValue": null, - "description": "Indicates whether the element should be focusable even when it is\n[`disabled`](https://ariakit.org/reference/focusable#disabled).\n\nThis is important when discoverability is a concern. For example:\n\n> A toolbar in an editor contains a set of special smart paste functions\nthat are disabled when the clipboard is empty or when the function is not\napplicable to the current content of the clipboard. It could be helpful to\nkeep the disabled buttons focusable if the ability to discover their\nfunctionality is primarily via their presence on the toolbar.\n\nLearn more on [Focusability of disabled\ncontrols](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "accessibleWhenDisabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "alwaysVisible": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the content element should remain visible even when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state is\n`false`. If this prop is set to `true`, the `hidden` prop and the `display:\nnone` style will not be applied, unless explicitly set otherwise.\n\nThis prop is particularly useful when using third-party animation libraries\nsuch as Framer Motion or React Spring, where the element needs to be\nvisible for exit animations to work.\n\nLive examples:\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Menu with Framer\n Motion](https://ariakit.org/examples/menu-framer-motion)\n- [Tooltip with Framer\n Motion](https://ariakit.org/examples/tooltip-framer-motion)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)", - "name": "alwaysVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "arrowPadding": { - "defaultValue": { - "value": "4" - }, - "description": "The minimum padding between the arrow and the popover corner.", - "name": "arrowPadding", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "autoFocus": { - "defaultValue": { - "value": "false" - }, - "description": "Automatically focuses the element upon mounting, similar to the native\n`autoFocus` prop. This addresses an issue where the element with the native\n`autoFocus` attribute might receive focus before React effects are\nexecuted.\n\nThe `autoFocus` prop can also be used with\n[Focusable](https://ariakit.org/components/focusable) elements within a\n[Dialog](https://ariakit.org/components/dialog) component, establishing the\ninitial focus as the dialog opens.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with React\n Router](https://ariakit.org/examples/dialog-react-router)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)", - "name": "autoFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoFocusOnHide": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element outside of the dialog will be focused when\nthe dialog is hidden if another element hasn't been focused in the action\nof hiding the dialog (for example, by clicking or tabbing into another\ntabbable element outside of the dialog).\n\nBy default, this is usually the disclosure element. The\n[`finalFocus`](https://ariakit.org/reference/dialog#finalfocus) prop can be\nused to define a different element to be focused.\n\nLive examples:\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n- [Sliding menu](https://ariakit.org/examples/menu-slide)", - "name": "autoFocusOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "autoFocusOnShow": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether an element inside the dialog will receive focus when the\ndialog is shown. By default, this is usually the first tabbable element in\nthe dialog or the dialog itself. The\n[`initialFocus`](https://ariakit.org/reference/dialog#initialfocus) prop\ncan be used to set a different element to receive focus.\n\nLive examples:\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "autoFocusOnShow", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: HTMLElement) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "backdrop": { - "defaultValue": null, - "description": "Determines whether there will be a backdrop behind the dialog. On modal\ndialogs, this is `true` by default. Besides a `boolean`, this prop can also\nbe a React component or JSX element that will be rendered as the backdrop.\n\n**Note**: If a custom component is used, it must [accept ref and spread all\nprops to its underlying DOM\nelement](https://ariakit.org/guide/composition#custom-components-must-be-open-for-extension),\nthe same way a native element would.\n\nLive examples:\n- [Animated Dialog](https://ariakit.org/examples/dialog-animated)\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with Framer\n Motion](https://ariakit.org/examples/dialog-framer-motion)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Nested Dialog](https://ariakit.org/examples/dialog-nested)\n- [Dialog with Next.js App\n Router](https://ariakit.org/examples/dialog-next-router)\n@example ```jsx\n} />\n```", - "name": "backdrop", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean | ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes<...>> & { ...; }, string | JSXElementConstructor<...>> | ElementType<...>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "ReactElement, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, string | JSXElementConstructor<...>>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "ComponentClass, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }, any>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent, HTMLDivElement>, \"key\" | keyof HTMLAttributes> & { ...; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "disablePointerEventsOnApproach": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the pointer events outside of the popover and its anchor\nelement should be disabled during _hover intent_, that is, when the mouse\nis moving toward the popover.\n\nThis is required as these external events may trigger focus on other\nelements and close the popover while the user is attempting to hover over\nit.\n\nThis can be either a boolean or a callback receiving the mouse event\nhappening during hover intent. The callback should return a boolean.", - "name": "disablePointerEventsOnApproach", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: MouseEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "disabled": { - "defaultValue": { - "value": "false" - }, - "description": "Determines if the element is disabled. This sets the `aria-disabled`\nattribute accordingly, enabling support for all elements, including those\nthat don't support the native `disabled` attribute.\n\nThis feature can be combined with the\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled)\nprop to make disabled elements still accessible via keyboard.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Context Menu](https://ariakit.org/examples/menu-context-menu)", - "name": "disabled", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "finalFocus": { - "defaultValue": null, - "description": "Determines the element that will receive focus once the dialog is closed,\nprovided that no other element has been focused while the dialog was being\nhidden (e.g., by clicking or tabbing into another tabbable element outside\nof the dialog).\n- If\n [`autoFocusOnHide`](https://ariakit.org/reference/dialog#autofocusonhide)\n is set to `false`, this prop will have no effect.\n- If left unset, the element that was focused before the dialog was opened\n will be focused again.", - "name": "finalFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "fitViewport": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover should fit the viewport. If this is set to true, the\npopover wrapper will have `maxWidth` and `maxHeight` set to the viewport\nsize. This will be exposed to CSS as\n[`--popover-available-width`](https://ariakit.org/guide/styling#--popover-available-width)\nand\n[`--popover-available-height`](https://ariakit.org/guide/styling#--popover-available-height).\n\nLive examples:\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Menubar](https://ariakit.org/components/menubar)", - "name": "fitViewport", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "fixed": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover has `position: fixed` or not.", - "name": "fixed", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "flip": { - "defaultValue": { - "value": "true" - }, - "description": "Controls the behavior of the popover when it overflows the viewport:\n- If a `boolean`, specifies whether the popover should flip to the opposite\n side when it overflows.\n- If a `string`, indicates the preferred fallback placements when it\n overflows. The placements must be spaced-delimited, e.g. \"top left\".\n\nLive examples:\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)\n- [Menubar](https://ariakit.org/components/menubar)", - "name": "flip", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "focusable": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if [Focusable](https://ariakit.org/components/focusable)\nfeatures should be active on non-native focusable elements.\n\n**Note**: This prop only turns off the additional features provided by the\n[`Focusable`](https://ariakit.org/reference/focusable) component.\nNon-native focusable elements will lose their focusability entirely.\nHowever, native focusable elements will retain their inherent focusability,\nbut without added features such as improved\n[`autoFocus`](https://ariakit.org/reference/focusable#autofocus),\n[`accessibleWhenDisabled`](https://ariakit.org/reference/focusable#accessiblewhendisabled),\n[`onFocusVisible`](https://ariakit.org/reference/focusable#onfocusvisible),\netc.", - "name": "focusable", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "getAnchorRect": { - "defaultValue": null, - "description": "Function that returns the anchor element's DOMRect. If this is explicitly\npassed, it will override the anchor `getBoundingClientRect` method.\n\nLive examples:\n - [Textarea with inline combobox](https://ariakit.org/examples/combobox-textarea)\n - [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n - [Context menu](https://ariakit.org/examples/menu-context-menu)\n - [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "getAnchorRect", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "(anchor: HTMLElement) => AnchorRect" - } - }, - "getPersistentElements": { - "defaultValue": null, - "description": "When a dialog is open, the elements outside of it are disabled to prevent\ninteraction if the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). For non-modal\ndialogs, interacting with elements outside the dialog prompts it to close.\n\nThis function allows you to return an iterable collection of elements that\nwill be considered as part of the dialog, thus excluding them from this\nbehavior.\n\n**Note**: The elements returned by this function must exist in the DOM when\nthe dialog opens.\n\nLive examples:\n- [Dialog with\n React-Toastify](https://ariakit.org/examples/dialog-react-toastify)", - "name": "getPersistentElements", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "() => Iterable" - } - }, - "gutter": { - "defaultValue": { - "value": "0" - }, - "description": "The distance between the popover and the anchor element.\n\nLive examples:\n- [Combobox filtering](https://ariakit.org/examples/combobox-filtering)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Hovercard with keyboard support](https://ariakit.org/examples/hovercard-disclosure)\n- [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Toolbar with Select](https://ariakit.org/examples/toolbar-select)", - "name": "gutter", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "hideOnEscape": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog will hide when the user presses the Escape key.\n\nThis prop can be either a boolean or a function that accepts an event as an\nargument and returns a boolean. The event object represents the keydown\nevent that initiated the hide action, which could be either a native\nkeyboard event or a React synthetic event.\n\n**Note**: When placing Ariakit dialogs inside third-party dialogs, using\n`event.stopPropagation()` within this function will stop the event from\nreaching the third-party dialog, closing only the Ariakit dialog.", - "name": "hideOnEscape", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: KeyboardEvent | React.KeyboardEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnHoverOutside": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the popover should hide when the mouse leaves the\npopover or the anchor element and there's no _hover intent_, meaning, the\nmouse isn't moving toward the popover.\n\nThis can be either a boolean or a callback receiving the mouse move event\nthat initiated the behavior. The callback should return a boolean.\n\n**Note**: This behavior won't be triggered when the popover or any of its\ndescendants are in focus.", - "name": "hideOnHoverOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: MouseEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "hideOnInteractOutside": { - "defaultValue": { - "value": "true" - }, - "description": "Determines if the dialog should hide when the user clicks or focuses on an\nelement outside the dialog.\n\nThis prop can be either a boolean or a function that takes an event as an\nargument and returns a boolean. The event object represents the event that\ntriggered the action, which could be a native event or a React synthetic\nevent of various types.\n\nLive examples:\n- [Selection Popover](https://ariakit.org/examples/popover-selection)", - "name": "hideOnInteractOutside", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "BooleanOrCallback>", - "value": [ - { - "value": "false" - }, - { - "value": "true" - }, - { - "value": "(arg: Event | SyntheticEvent) => boolean", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "initialFocus": { - "defaultValue": null, - "description": "Specifies the element that will receive focus when the dialog is first\nopened. It can be an `HTMLElement` or a `React.RefObject` with an\n`HTMLElement`.\n\nIf\n[`autoFocusOnShow`](https://ariakit.org/reference/dialog#autofocusonshow)\nis set to `false`, this prop will have no effect. If left unset, the dialog\nwill attempt to determine the initial focus element in the following order:\n1. A [Focusable](https://ariakit.org/components/focusable) element with an\n [`autoFocus`](https://ariakit.org/reference/focusable#autofocus) prop.\n2. The first tabbable element inside the dialog.\n3. The first focusable element inside the dialog.\n4. The dialog element itself.", - "name": "initialFocus", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | RefObject", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "RefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "modal": { - "defaultValue": { - "value": "false" - }, - "description": "Determines whether the dialog is modal. Modal dialogs have distinct states\nand behaviors:\n- The [`portal`](https://ariakit.org/reference/dialog#portal) and\n [`preventBodyScroll`](https://ariakit.org/reference/dialog#preventbodyscroll)\n props are set to `true`. They can still be manually set to `false`.\n- When using the [`Heading`](https://ariakit.org/reference/heading) or\n [`DialogHeading`](https://ariakit.org/reference/dialog-heading)\n components within the dialog, their level will be reset so they start\n with `h1`.\n- A visually hidden dismiss button will be rendered if the\n [`DialogDismiss`](https://ariakit.org/reference/dialog-dismiss) component\n hasn't been used. This allows screen reader users to close the dialog.\n- When the dialog is open, element tree outside it will be inert.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Context menu](https://ariakit.org/examples/menu-context-menu)\n- [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "modal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/hovercard/hovercard.d.ts", - "name": "HovercardOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "onClose": { - "defaultValue": null, - "description": "call a function when popover closed", - "name": "onClose", - "parent": { - "fileName": "lib/src/components/Popover/PopoverHover.tsx", - "name": "PopoverHoverOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Popover/PopoverHover.tsx", - "name": "PopoverHoverOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "onFocusVisible": { - "defaultValue": null, - "description": "Custom event handler invoked when the element gains focus through keyboard\ninteraction or a key press occurs while the element is in focus. This is\nthe programmatic equivalent of the\n[`data-focus-visible`](https://ariakit.org/guide/styling#data-focus-visible)\nattribute.\n\n**Note**: For this prop to work, the\n[`focusable`](https://ariakit.org/reference/command#focusable) prop must be\nset to `true`, if it's not set by default.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)", - "name": "onFocusVisible", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/focusable/focusable.d.ts", - "name": "FocusableOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(event: SyntheticEvent) => void>" - } - }, - "open": { - "defaultValue": null, - "description": "Controls the open state of the dialog. This is similar to the\n[`open`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/open)\nattribute on native dialog elements.\n\nLive examples:\n- [Dialog with scrollable\n backdrop](https://ariakit.org/examples/dialog-backdrop-scrollable)\n- [Dialog with details &\n summary](https://ariakit.org/examples/dialog-details)\n- [Warning on Dialog\n hide](https://ariakit.org/examples/dialog-hide-warning)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)", - "name": "open", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "overflowPadding": { - "defaultValue": { - "value": "8" - }, - "description": "The minimum padding between the popover and the viewport edge. This will be\nexposed to CSS as\n[`--popover-overflow-padding`](https://ariakit.org/guide/styling#--popover-overflow-padding).\n\nLive examples:\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)", - "name": "overflowPadding", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "overlap": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover can overlap the anchor element when it overflows.\n\nLive examples:\n- [Menubar](https://ariakit.org/components/menubar)\n- [Submenu with\n Combobox](https://ariakit.org/examples/menu-nested-combobox)", - "name": "overlap", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portal": { - "defaultValue": { - "value": "true" - }, - "description": "Determines whether the element should be rendered as a React Portal.\n\nLive examples:\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Dialog with Menu](https://ariakit.org/examples/dialog-menu)\n- [Hovercard with keyboard\n support](https://ariakit.org/examples/hovercard-disclosure)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)", - "name": "portal", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "portalElement": { - "defaultValue": null, - "description": "An HTML element or a memoized callback function that returns an HTML\nelement to be used as the portal element. By default, the portal element\nwill be a `div` element appended to the `document.body`.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n@example ```jsx\nconst [portal, setPortal] = useState(null);\n\n\n
\n```\n@example ```jsx\nconst getPortalElement = useCallback(() => {\n const div = document.createElement(\"div\");\n const portalRoot = document.getElementById(\"portal-root\");\n portalRoot.appendChild(div);\n return div;\n}, []);\n\n\n```", - "name": "portalElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "HTMLElement | ((element: HTMLElement) => HTMLElement)", - "value": [ - { - "value": "HTMLElement", - "description": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "fullComment": "Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it.", - "tags": {} - }, - { - "value": "(element: HTMLElement) => HTMLElement", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "portalRef": { - "defaultValue": null, - "description": "`portalRef` is similar to `ref` but is scoped to the portal node. It's\nuseful when you need to be informed when the portal element is appended to\nthe DOM or removed from the DOM.\n\nLive examples:\n- [Form with Select](https://ariakit.org/examples/form-select)\n@example ```jsx\nconst [portalElement, setPortalElement] = useState(null);\n\n\n```", - "name": "portalRef", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "RefCallback | MutableRefObject", - "value": [ - { - "value": "RefCallback", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "MutableRefObject", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "preserveTabOrder": { - "defaultValue": { - "value": "false" - }, - "description": "When enabled, `preserveTabOrder` will keep the DOM element's tab order the\nsame as the order in which the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted in\nthe React tree.\n\nIf the\n[`preserveTabOrderAnchor`](https://ariakit.org/reference/portal#preservetaborderanchor)\nprop is provided, the tab order will be preserved relative to that element.", - "name": "preserveTabOrder", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "preserveTabOrderAnchor": { - "defaultValue": null, - "description": "An anchor element for maintaining the tab order when\n[`preserveTabOrder`](https://ariakit.org/reference/portal#preservetaborder)\nprop is enabled. The tab order will be kept relative to this element.\n\nBy default, the tab order is kept relative to the original location in the\nReact tree where the underlying\n[`Portal`](https://ariakit.org/reference/portal) component was mounted.\n@example ```jsx {18-20}\nconst [anchor, setAnchor] = useState(null);\n\n\n\n\n// Rendered at the end of the document.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved.\n\n \n\n\n// Rendered at the end of the document, but the tab order is preserved\n// relative to the anchor element.\n\n \n\n\n\n```", - "name": "preserveTabOrderAnchor", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/portal/portal.d.ts", - "name": "PortalOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "preventBodyScroll": { - "defaultValue": null, - "description": "Determines whether the body scrolling will be prevented when the dialog is\nshown. This is automatically set to `true` when the dialog is\n[`modal`](https://ariakit.org/reference/dialog#modal). You can disable this\nprop if you want to implement your own logic.", - "name": "preventBodyScroll", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "render": { - "defaultValue": null, - "description": "Allows the component to be rendered as a different HTML element or React\ncomponent. The value can be a React element or a function that takes in the\noriginal component props and gives back a React element with the props\nmerged.\n\nCheck out the [Composition](https://ariakit.org/guide/composition) guide\nfor more details.", - "name": "render", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ReactElement> | RenderProp & { ref?: Ref; }>", - "value": [ - { - "value": "ReactElement>", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "RenderProp & { ref?: Ref; }>", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "sameWidth": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the popover should have the same width as the anchor element. This\nwill be exposed to CSS as\n[`--popover-anchor-width`](https://ariakit.org/guide/styling#--popover-anchor-width).", - "name": "sameWidth", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "shift": { - "defaultValue": { - "value": "0" - }, - "description": "The skidding of the popover along the anchor element. Can be set to\nnegative values to make the popover shift to the opposite side.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Menubar](https://ariakit.org/components/menubar)\n- [Select with Combobox and\n Tabs](https://ariakit.org/examples/select-combobox-tab)", - "name": "shift", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "slide": { - "defaultValue": { - "value": "true" - }, - "description": "Whether the popover should slide when it overflows.", - "name": "slide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "store": { - "defaultValue": null, - "description": "Object returned by the\n[`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)\nhook. If not provided, the closest\n[`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)\ncomponent's context will be used.", - "name": "store", - "parent": { - "fileName": "lib/src/components/Popover/PopoverHover.tsx", - "name": "PopoverHoverOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Popover/PopoverHover.tsx", - "name": "PopoverHoverOptions" - } - ], - "required": true, - "type": { - "name": "HovercardStore & Pick" - } - }, - "unmountOnHide": { - "defaultValue": { - "value": "false" - }, - "description": "When set to `true`, the content element will be unmounted and removed from\nthe DOM when it's hidden.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Combobox with integrated\n filter](https://ariakit.org/examples/combobox-filtering-integrated)\n- [Textarea with inline\n Combobox](https://ariakit.org/examples/combobox-textarea)\n- [Standalone Popover](https://ariakit.org/examples/popover-standalone)\n- [Animated Select](https://ariakit.org/examples/select-animated)\n- [Multi-Select](https://ariakit.org/examples/select-multiple)", - "name": "unmountOnHide", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-content.d.ts", - "name": "DisclosureContentOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "unstable_treeSnapshotKey": { - "defaultValue": null, - "description": "@private", - "name": "unstable_treeSnapshotKey", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/dialog/dialog.d.ts", - "name": "DialogOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | number | boolean", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "updatePosition": { - "defaultValue": null, - "description": "A callback that will be called when the popover needs to calculate its\nposition. This will override the internal `updatePosition` function. The\noriginal `updatePosition` function will be passed as an argument, so it can\nbe called inside the callback to apply the default behavior.\n\nLive examples:\n - [Responsive Popover](https://ariakit.org/examples/popover-responsive)", - "name": "updatePosition", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "(props: { updatePosition: () => Promise; }) => void | Promise" - } - }, - "wrapElement": { - "defaultValue": null, - "description": "", - "name": "wrapElement", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/utils/types.d.ts", - "name": "Options" - } - ], - "required": false, - "type": { - "name": "WrapElement" - } - }, - "wrapperProps": { - "defaultValue": null, - "description": "Props that will be passed to the popover wrapper element. This element will\nbe used to position the popover.\n\nLive examples:\n- [Navigation Menubar](https://ariakit.org/examples/menubar-navigation)\n- [Sliding Menu](https://ariakit.org/examples/menu-slide)", - "name": "wrapperProps", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/popover/popover.d.ts", - "name": "PopoverOptions" - } - ], - "required": false, - "type": { - "name": "HTMLAttributes" - } - } - } - }, - "usePopover": { - "props": { - "animated": { - "defaultValue": { - "value": 150 - }, - "description": "Determines whether the content should animate when it is shown or hidden.\n- If `true`, the `animating` state will be `true` when the content is shown\n or hidden and it will wait for a CSS animation/transition to end before\n becoming `false`.\n- If it's set to a number, the `animating` state will be `true` when the\n content is shown or hidden and it will wait for the number of\n milliseconds to pass before becoming `false`.\n@deprecated Manually setting the `animated` prop is no longer necessary.\nThis will be removed in a future release.", - "name": "animated", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "number | boolean", - "value": [ - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "defaultOpen": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the content should be visible by default.", - "name": "defaultOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disclosure": { - "defaultValue": null, - "description": "A reference to another disclosure store that controls another disclosure\ncomponent to keep them in sync. Element states like `contentElement` and\n`disclosureElement` won't be synced. For that, use the\n[`store`](https://ariakit.org/reference/disclosure-provider#store) prop\ninstead.\n\nLive examples:\n- [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)", - "name": "disclosure", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "DisclosureStore" - } - }, - "popover": { - "defaultValue": null, - "description": "A reference to another popover store that's controlling another popover to\nkeep them in sync.", - "name": "popover", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts", - "name": "PopoverStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts", - "name": "PopoverStoreOptions" - } - ], - "required": false, - "type": { - "name": "PopoverStore" - } - }, - "setMounted": { - "defaultValue": null, - "description": "A callback that gets called when the `mounted` state changes.\n@example const [mounted, setMounted] = useState(false);\nconst disclosure = useDisclosureStore({ setMounted });", - "name": "setMounted", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(mounted: boolean) => void" - } - }, - "setOpen": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state\nchanges.\n@example const [open, setOpen] = useState(false);\nconst disclosure = useDisclosureStore({ open, setOpen });", - "name": "setOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(open: boolean) => void" - } - } - } - }, - "usePopoverHover": { - "props": { - "animated": { - "defaultValue": { - "value": 150 - }, - "description": "Determines whether the content should animate when it is shown or hidden.\n- If `true`, the `animating` state will be `true` when the content is shown\n or hidden and it will wait for a CSS animation/transition to end before\n becoming `false`.\n- If it's set to a number, the `animating` state will be `true` when the\n content is shown or hidden and it will wait for the number of\n milliseconds to pass before becoming `false`.\n@deprecated Manually setting the `animated` prop is no longer necessary.\nThis will be removed in a future release.", - "name": "animated", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "number | boolean", - "value": [ - { - "value": "number" - }, - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "defaultOpen": { - "defaultValue": { - "value": "false" - }, - "description": "Whether the content should be visible by default.", - "name": "defaultOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disclosure": { - "defaultValue": null, - "description": "A reference to another disclosure store that controls another disclosure\ncomponent to keep them in sync. Element states like `contentElement` and\n`disclosureElement` won't be synced. For that, use the\n[`store`](https://ariakit.org/reference/disclosure-provider#store) prop\ninstead.\n\nLive examples:\n- [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)", - "name": "disclosure", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "DisclosureStore" - } - }, - "popover": { - "defaultValue": null, - "description": "A reference to another popover store that's controlling another popover to\nkeep them in sync.", - "name": "popover", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts", - "name": "PopoverStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/popover/popover-store.d.ts", - "name": "PopoverStoreOptions" - } - ], - "required": false, - "type": { - "name": "PopoverStore" - } - }, - "setMounted": { - "defaultValue": null, - "description": "A callback that gets called when the `mounted` state changes.\n@example const [mounted, setMounted] = useState(false);\nconst disclosure = useDisclosureStore({ setMounted });", - "name": "setMounted", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(mounted: boolean) => void" - } - }, - "setOpen": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`open`](https://ariakit.org/reference/disclosure-provider#open) state\nchanges.\n@example const [open, setOpen] = useState(false);\nconst disclosure = useDisclosureStore({ open, setOpen });", - "name": "setOpen", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts", - "name": "DisclosureStoreOptions" - } - ], - "required": false, - "type": { - "name": "(open: boolean) => void" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/RadioGroup/docs/properties.json b/lib/src/components/RadioGroup/docs/properties.json deleted file mode 100644 index eddb848e8..000000000 --- a/lib/src/components/RadioGroup/docs/properties.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "RadioGroup": { - "props": { - "label": { - "defaultValue": null, - "description": "", - "name": "label", - "parent": { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - } - ], - "required": true, - "type": { - "name": "string" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - } - ], - "required": false, - "type": { - "name": "(value: string | number) => void" - } - }, - "options": { - "defaultValue": { - "value": "[]" - }, - "description": "", - "name": "options", - "parent": { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - } - ], - "required": false, - "type": { - "name": "RadioGroupOption[]" - } - }, - "renderOption": { - "defaultValue": null, - "description": "", - "name": "renderOption", - "parent": { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "ElementType", - "value": [ - { - "value": "\"symbol\"" - }, - { - "value": "\"object\"" - }, - { - "value": "\"a\"" - }, - { - "value": "\"abbr\"" - }, - { - "value": "\"address\"" - }, - { - "value": "\"area\"" - }, - { - "value": "\"article\"" - }, - { - "value": "\"aside\"" - }, - { - "value": "\"audio\"" - }, - { - "value": "\"b\"" - }, - { - "value": "\"base\"" - }, - { - "value": "\"bdi\"" - }, - { - "value": "\"bdo\"" - }, - { - "value": "\"big\"" - }, - { - "value": "\"blockquote\"" - }, - { - "value": "\"body\"" - }, - { - "value": "\"br\"" - }, - { - "value": "\"button\"" - }, - { - "value": "\"canvas\"" - }, - { - "value": "\"caption\"" - }, - { - "value": "\"cite\"" - }, - { - "value": "\"code\"" - }, - { - "value": "\"col\"" - }, - { - "value": "\"colgroup\"" - }, - { - "value": "\"data\"" - }, - { - "value": "\"datalist\"" - }, - { - "value": "\"dd\"" - }, - { - "value": "\"del\"" - }, - { - "value": "\"details\"" - }, - { - "value": "\"dfn\"" - }, - { - "value": "\"dialog\"" - }, - { - "value": "\"div\"" - }, - { - "value": "\"dl\"" - }, - { - "value": "\"dt\"" - }, - { - "value": "\"em\"" - }, - { - "value": "\"embed\"" - }, - { - "value": "\"fieldset\"" - }, - { - "value": "\"figcaption\"" - }, - { - "value": "\"figure\"" - }, - { - "value": "\"footer\"" - }, - { - "value": "\"form\"" - }, - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"head\"" - }, - { - "value": "\"header\"" - }, - { - "value": "\"hgroup\"" - }, - { - "value": "\"hr\"" - }, - { - "value": "\"html\"" - }, - { - "value": "\"i\"" - }, - { - "value": "\"iframe\"" - }, - { - "value": "\"img\"" - }, - { - "value": "\"input\"" - }, - { - "value": "\"ins\"" - }, - { - "value": "\"kbd\"" - }, - { - "value": "\"keygen\"" - }, - { - "value": "\"label\"" - }, - { - "value": "\"legend\"" - }, - { - "value": "\"li\"" - }, - { - "value": "\"link\"" - }, - { - "value": "\"main\"" - }, - { - "value": "\"map\"" - }, - { - "value": "\"mark\"" - }, - { - "value": "\"menu\"" - }, - { - "value": "\"menuitem\"" - }, - { - "value": "\"meta\"" - }, - { - "value": "\"meter\"" - }, - { - "value": "\"nav\"" - }, - { - "value": "\"noindex\"" - }, - { - "value": "\"noscript\"" - }, - { - "value": "\"ol\"" - }, - { - "value": "\"optgroup\"" - }, - { - "value": "\"option\"" - }, - { - "value": "\"output\"" - }, - { - "value": "\"p\"" - }, - { - "value": "\"param\"" - }, - { - "value": "\"picture\"" - }, - { - "value": "\"pre\"" - }, - { - "value": "\"progress\"" - }, - { - "value": "\"q\"" - }, - { - "value": "\"rp\"" - }, - { - "value": "\"rt\"" - }, - { - "value": "\"ruby\"" - }, - { - "value": "\"s\"" - }, - { - "value": "\"samp\"" - }, - { - "value": "\"slot\"" - }, - { - "value": "\"script\"" - }, - { - "value": "\"section\"" - }, - { - "value": "\"select\"" - }, - { - "value": "\"small\"" - }, - { - "value": "\"source\"" - }, - { - "value": "\"span\"" - }, - { - "value": "\"strong\"" - }, - { - "value": "\"style\"" - }, - { - "value": "\"sub\"" - }, - { - "value": "\"summary\"" - }, - { - "value": "\"sup\"" - }, - { - "value": "\"table\"" - }, - { - "value": "\"template\"" - }, - { - "value": "\"tbody\"" - }, - { - "value": "\"td\"" - }, - { - "value": "\"textarea\"" - }, - { - "value": "\"tfoot\"" - }, - { - "value": "\"th\"" - }, - { - "value": "\"thead\"" - }, - { - "value": "\"time\"" - }, - { - "value": "\"title\"" - }, - { - "value": "\"tr\"" - }, - { - "value": "\"track\"" - }, - { - "value": "\"u\"" - }, - { - "value": "\"ul\"" - }, - { - "value": "\"var\"" - }, - { - "value": "\"video\"" - }, - { - "value": "\"wbr\"" - }, - { - "value": "\"webview\"" - }, - { - "value": "\"svg\"" - }, - { - "value": "\"animate\"" - }, - { - "value": "\"animateMotion\"" - }, - { - "value": "\"animateTransform\"" - }, - { - "value": "\"circle\"" - }, - { - "value": "\"clipPath\"" - }, - { - "value": "\"defs\"" - }, - { - "value": "\"desc\"" - }, - { - "value": "\"ellipse\"" - }, - { - "value": "\"feBlend\"" - }, - { - "value": "\"feColorMatrix\"" - }, - { - "value": "\"feComponentTransfer\"" - }, - { - "value": "\"feComposite\"" - }, - { - "value": "\"feConvolveMatrix\"" - }, - { - "value": "\"feDiffuseLighting\"" - }, - { - "value": "\"feDisplacementMap\"" - }, - { - "value": "\"feDistantLight\"" - }, - { - "value": "\"feDropShadow\"" - }, - { - "value": "\"feFlood\"" - }, - { - "value": "\"feFuncA\"" - }, - { - "value": "\"feFuncB\"" - }, - { - "value": "\"feFuncG\"" - }, - { - "value": "\"feFuncR\"" - }, - { - "value": "\"feGaussianBlur\"" - }, - { - "value": "\"feImage\"" - }, - { - "value": "\"feMerge\"" - }, - { - "value": "\"feMergeNode\"" - }, - { - "value": "\"feMorphology\"" - }, - { - "value": "\"feOffset\"" - }, - { - "value": "\"fePointLight\"" - }, - { - "value": "\"feSpecularLighting\"" - }, - { - "value": "\"feSpotLight\"" - }, - { - "value": "\"feTile\"" - }, - { - "value": "\"feTurbulence\"" - }, - { - "value": "\"filter\"" - }, - { - "value": "\"foreignObject\"" - }, - { - "value": "\"g\"" - }, - { - "value": "\"image\"" - }, - { - "value": "\"line\"" - }, - { - "value": "\"linearGradient\"" - }, - { - "value": "\"marker\"" - }, - { - "value": "\"mask\"" - }, - { - "value": "\"metadata\"" - }, - { - "value": "\"mpath\"" - }, - { - "value": "\"path\"" - }, - { - "value": "\"pattern\"" - }, - { - "value": "\"polygon\"" - }, - { - "value": "\"polyline\"" - }, - { - "value": "\"radialGradient\"" - }, - { - "value": "\"rect\"" - }, - { - "value": "\"stop\"" - }, - { - "value": "\"switch\"" - }, - { - "value": "\"text\"" - }, - { - "value": "\"textPath\"" - }, - { - "value": "\"tspan\"" - }, - { - "value": "\"use\"" - }, - { - "value": "\"view\"" - }, - { - "value": "ComponentClass", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "FunctionComponent", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - }, - "required": { - "defaultValue": null, - "description": "", - "name": "required", - "parent": { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/FieldGroup/index.tsx", - "name": "FieldGroupOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioGroup/index.tsx", - "name": "RadioGroupOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/RadioTab/docs/properties.json b/lib/src/components/RadioTab/docs/properties.json deleted file mode 100644 index a82c37953..000000000 --- a/lib/src/components/RadioTab/docs/properties.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "RadioTab": { - "props": { - "checked": { - "defaultValue": null, - "description": "", - "name": "checked", - "parent": { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabledIcon": { - "defaultValue": null, - "description": "", - "name": "disabledIcon", - "parent": { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - }, - "label": { - "defaultValue": null, - "description": "", - "name": "label", - "parent": { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - } - ], - "required": true, - "type": { - "name": "ReactElement>" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - } - ], - "required": false, - "type": { - "name": "(event: ChangeEvent) => void" - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/RadioTab/index.tsx", - "name": "RadioTabsOptions" - } - ], - "required": true, - "type": { - "name": "enum", - "raw": "string | number", - "value": [ - { - "value": "string" - }, - { - "value": "number" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Search/docs/properties.json b/lib/src/components/Search/docs/properties.json deleted file mode 100644 index 9ab9ff8e7..000000000 --- a/lib/src/components/Search/docs/properties.json +++ /dev/null @@ -1,209 +0,0 @@ -{ - "Search": { - "props": { - "groupsEnabled": { - "defaultValue": null, - "description": "", - "name": "groupsEnabled", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - }, - "itemToString": { - "defaultValue": null, - "description": "", - "name": "itemToString", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": true, - "type": { - "name": "(item: unknown) => string" - } - }, - "minChars": { - "defaultValue": { - "value": 3 - }, - "description": "", - "name": "minChars", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "(item: unknown, event: { preventDefault: () => void; target: Record; }) => void" - } - }, - "renderGroupHeader": { - "defaultValue": null, - "description": "", - "name": "renderGroupHeader", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "(result: SearchOptionGroup) => ReactElement>" - } - }, - "renderItem": { - "defaultValue": null, - "description": "", - "name": "renderItem", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": true, - "type": { - "name": "(item: unknown) => string | ReactElement>" - } - }, - "search": { - "defaultValue": null, - "description": "", - "name": "search", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": true, - "type": { - "name": "(query: string) => Promise" - } - }, - "throttle": { - "defaultValue": { - "value": 500 - }, - "description": "", - "name": "throttle", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Search/index.tsx", - "name": "SearchOptions" - } - ], - "required": false, - "type": { - "name": "unknown" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Select/docs/properties.json b/lib/src/components/Select/docs/properties.json deleted file mode 100644 index f13485306..000000000 --- a/lib/src/components/Select/docs/properties.json +++ /dev/null @@ -1,628 +0,0 @@ -{ - "Select": { - "props": { - "allowUnselectFromList": { - "defaultValue": null, - "description": "", - "name": "allowUnselectFromList", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "autoComplete": { - "defaultValue": { - "value": "off" - }, - "description": "We need to add `autoComplete` off to avoid select UI issues when is an input", - "name": "autoComplete", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "autoFocus": { - "defaultValue": null, - "description": "", - "name": "autoFocus", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disableCloseOnSelect": { - "defaultValue": null, - "description": "", - "name": "disableCloseOnSelect", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "groupsEnabled": { - "defaultValue": null, - "description": "", - "name": "groupsEnabled", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "ReactElement>" - } - }, - "id": { - "defaultValue": null, - "description": "", - "name": "id", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "isClearable": { - "defaultValue": null, - "description": "", - "name": "isClearable", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "isCreatable": { - "defaultValue": null, - "description": "", - "name": "isCreatable", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "isMultiple": { - "defaultValue": null, - "description": "", - "name": "isMultiple", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "isSearchable": { - "defaultValue": null, - "description": "", - "name": "isSearchable", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(value: SelectOptionValue | SelectOptionValue[], event?: CreateEvent) => void" - } - }, - "onClick": { - "defaultValue": null, - "description": "", - "name": "onClick", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(event: MouseEvent) => void" - } - }, - "onCreate": { - "defaultValue": null, - "description": "", - "name": "onCreate", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(option: string, event: CreateEvent) => void" - } - }, - "onFocus": { - "defaultValue": null, - "description": "", - "name": "onFocus", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "options": { - "defaultValue": null, - "description": "", - "name": "options", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": true, - "type": { - "name": "SelectOptionsType" - } - }, - "placeholder": { - "defaultValue": { - "value": "Choose from…" - }, - "description": "", - "name": "placeholder", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "renderCreateItem": { - "defaultValue": { - "value": "(inputValue: string) => `Create \"${inputValue}\"`" - }, - "description": "", - "name": "renderCreateItem", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(inputValue: SelectValue) => void" - } - }, - "renderGroupHeader": { - "defaultValue": null, - "description": "", - "name": "renderGroupHeader", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(option: SelectOptionGroup) => ReactNode" - } - }, - "renderItem": { - "defaultValue": { - "value": "(item: SelectOption): string => (item ? item.label : EMPTY_STRING)" - }, - "description": "", - "name": "renderItem", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(item: SelectOption, isItemSelected?: boolean) => string | ReactElement>" - } - }, - "renderMultiple": { - "defaultValue": null, - "description": "", - "name": "renderMultiple", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "(values: SelectOption[], handleRemove: (value: string) => void) => ReactElement>" - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Select/index.tsx", - "name": "SelectOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "SelectValue", - "value": [ - { - "value": "string" - }, - { - "value": "number" - }, - { - "value": "SelectOption", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "string[]", - "description": "", - "fullComment": "", - "tags": {} - }, - { - "value": "(string | number | SelectOption)[]", - "description": "", - "fullComment": "", - "tags": {} - } - ] - } - } - } - }, - "StyledSelect": { - "props": {} - } -} \ No newline at end of file diff --git a/lib/src/components/Shape/docs/properties.json b/lib/src/components/Shape/docs/properties.json deleted file mode 100644 index 812502b9d..000000000 --- a/lib/src/components/Shape/docs/properties.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "Shape": { - "props": { - "shape": { - "defaultValue": null, - "description": "", - "name": "shape", - "parent": { - "fileName": "lib/src/components/Shape/index.tsx", - "name": "ShapeOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Shape/index.tsx", - "name": "ShapeOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"circle\" | \"square\"", - "value": [ - { - "value": "\"circle\"" - }, - { - "value": "\"square\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Slider/docs/properties.json b/lib/src/components/Slider/docs/properties.json deleted file mode 100644 index 6698902c5..000000000 --- a/lib/src/components/Slider/docs/properties.json +++ /dev/null @@ -1,268 +0,0 @@ -{ - "Slider": { - "props": { - "borderSelectorColor": { - "defaultValue": { - "value": "neutral-10" - }, - "description": "", - "name": "borderSelectorColor", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "hint": { - "defaultValue": null, - "description": "", - "name": "hint", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "label": { - "defaultValue": null, - "description": "", - "name": "label", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "max": { - "defaultValue": null, - "description": "", - "name": "max", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": true, - "type": { - "name": "number" - } - }, - "min": { - "defaultValue": null, - "description": "", - "name": "min", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": true, - "type": { - "name": "number" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": true, - "type": { - "name": "(value: number) => void" - } - }, - "step": { - "defaultValue": { - "value": 1 - }, - "description": "", - "name": "step", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "tooltip": { - "defaultValue": null, - "description": "", - "name": "tooltip", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "type": { - "defaultValue": null, - "description": "", - "name": "type", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Type", - "value": [ - { - "value": "\"inline\"" - }, - { - "value": "\"left-field\"" - }, - { - "value": "\"right-field\"" - } - ] - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": true, - "type": { - "name": "number" - } - }, - "values": { - "defaultValue": null, - "description": "", - "name": "values", - "parent": { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Slider/index.tsx", - "name": "SliderOptions" - } - ], - "required": false, - "type": { - "name": "number[]" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Stack/docs/properties.json b/lib/src/components/Stack/docs/properties.json deleted file mode 100644 index 7f53aa379..000000000 --- a/lib/src/components/Stack/docs/properties.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "Stack": { - "props": { - "direction": { - "defaultValue": { - "value": "column" - }, - "description": "", - "name": "direction", - "parent": { - "fileName": "lib/src/components/Stack/index.tsx", - "name": "StackOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Stack/index.tsx", - "name": "StackOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"row\" | \"column\"", - "value": [ - { - "value": "\"row\"" - }, - { - "value": "\"column\"" - } - ] - } - }, - "spacing": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "spacing", - "parent": { - "fileName": "lib/src/components/Stack/index.tsx", - "name": "StackOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Stack/index.tsx", - "name": "StackOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"xxs\" | \"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\" | \"xxl\"", - "value": [ - { - "value": "\"xxs\"" - }, - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - }, - { - "value": "\"xl\"" - }, - { - "value": "\"xxl\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Swiper/docs/properties.json b/lib/src/components/Swiper/docs/properties.json deleted file mode 100644 index defee4fc0..000000000 --- a/lib/src/components/Swiper/docs/properties.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "Swiper": { - "props": {} - } -} \ No newline at end of file diff --git a/lib/src/components/Table/docs/properties.json b/lib/src/components/Table/docs/properties.json deleted file mode 100644 index b38d5cf18..000000000 --- a/lib/src/components/Table/docs/properties.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "TableComponent": { - "props": { - "indent": { - "defaultValue": null, - "description": "Add space on first and last child on the Td and Th component", - "name": "indent", - "parent": { - "fileName": "lib/src/components/Table/index.tsx", - "name": "TableOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Table/index.tsx", - "name": "TableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - } - } - }, - "Table": { - "props": { - "indent": { - "defaultValue": null, - "description": "Add space on first and last child on the Td and Th component", - "name": "indent", - "parent": { - "fileName": "lib/src/components/Table/index.tsx", - "name": "TableOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Table/index.tsx", - "name": "TableOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Tabs/docs/properties.json b/lib/src/components/Tabs/docs/properties.json deleted file mode 100644 index fecfd9c15..000000000 --- a/lib/src/components/Tabs/docs/properties.json +++ /dev/null @@ -1,160 +0,0 @@ -{ - "Tab": { - "props": { - "combobox": { - "defaultValue": null, - "description": "A reference to a [combobox\nstore](https://ariakit.org/reference/use-combobox-store). This is\nautomatically set when rendering tabs inside a\n[Combobox](https://ariakit.org/components/combobox).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "combobox", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - } - ], - "required": false, - "type": { - "name": "ComboboxStore" - } - }, - "composite": { - "defaultValue": null, - "description": "A reference to another [composite\nstore](https://ariakit.org/reference/use-composite-store). This is\nautomatically set when rendering tabs as part of another composite widget,\nsuch as [Combobox](https://ariakit.org/components/combobox) or\n[Select](https://ariakit.org/components/select).\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)", - "name": "composite", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - } - ], - "required": false, - "type": { - "name": "CompositeStore" - } - }, - "defaultActiveId": { - "defaultValue": null, - "description": "The composite item id that should be active by default when the composite\nwidget is rendered. If `null`, the composite element itself will have focus\nand users will be able to navigate to it using arrow keys. If `undefined`,\nthe first enabled item will be focused.", - "name": "defaultActiveId", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "defaultItems": { - "defaultValue": { - "value": "[]" - }, - "description": "The defaut value for the\n[`items`](https://ariakit.org/reference/collection-provider#items) state.", - "name": "defaultItems", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - } - ], - "required": false, - "type": { - "name": "TabStoreItem[]" - } - }, - "defaultSelectedId": { - "defaultValue": null, - "description": "The id of the tab whose panel is currently visible. If it's `undefined`, it\nwill be automatically set to the first enabled tab.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Animated TabPanel](https://ariakit.org/examples/tab-panel-animated)\n- [Select with Combobox and\n Tabs](https://ariakit.org/examples/select-combobox-tab)", - "name": "defaultSelectedId", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "setActiveId": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`activeId`](https://ariakit.org/reference/composite-provider#activeid)\nstate changes.", - "name": "setActiveId", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/composite/composite-store.d.ts", - "name": "CompositeStoreOptions" - } - ], - "required": false, - "type": { - "name": "(activeId: string) => void" - } - }, - "setItems": { - "defaultValue": null, - "description": "A callback that gets called when the\n[`items`](https://ariakit.org/reference/collection-provider#items) state\nchanges.\n@example const [items, setItems] = useState([]);\nconst collection = useCollectionStore({ items, setItems });", - "name": "setItems", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/collection/collection-store.d.ts", - "name": "CollectionStoreOptions" - } - ], - "required": false, - "type": { - "name": "BivariantCallback<(items: TabStoreItem[]) => void>" - } - }, - "setSelectedId": { - "defaultValue": null, - "description": "Function that will be called when the\n[`selectedId`](https://ariakit.org/reference/tab-provider#selectedid) state\nchanges.\n\nLive examples:\n- [Combobox with Tabs](https://ariakit.org/examples/combobox-tabs)\n- [Select with Combobox and\n Tabs](https://ariakit.org/examples/select-combobox-tab)", - "name": "setSelectedId", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tab/tab-store.d.ts", - "name": "TabStoreOptions" - } - ], - "required": false, - "type": { - "name": "(selectedId: string) => void" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Tag/docs/properties.json b/lib/src/components/Tag/docs/properties.json deleted file mode 100644 index 780dd5499..000000000 --- a/lib/src/components/Tag/docs/properties.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "Tag": { - "props": { - "href": { - "defaultValue": null, - "description": "", - "name": "href", - "parent": { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onClick": { - "defaultValue": null, - "description": "", - "name": "onClick", - "parent": { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "onRemove": { - "defaultValue": null, - "description": "", - "name": "onRemove", - "parent": { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - } - ] - } - }, - "to": { - "defaultValue": null, - "description": "", - "name": "to", - "parent": { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "variant": { - "defaultValue": { - "value": "default" - }, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Tag/index.tsx", - "name": "TagOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Variant", - "value": [ - { - "value": "\"blue\"" - }, - { - "value": "\"green\"" - }, - { - "value": "\"orange\"" - }, - { - "value": "\"pink\"" - }, - { - "value": "\"teal\"" - }, - { - "value": "\"violet\"" - }, - { - "value": "\"default\"" - }, - { - "value": "\"info\"" - }, - { - "value": "\"success\"" - }, - { - "value": "\"danger\"" - }, - { - "value": "\"warning\"" - }, - { - "value": "\"primary\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Text/docs/properties.json b/lib/src/components/Text/docs/properties.json deleted file mode 100644 index f78d84d00..000000000 --- a/lib/src/components/Text/docs/properties.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "Text": { - "props": { - "lines": { - "defaultValue": null, - "description": "", - "name": "lines", - "parent": { - "fileName": "lib/src/components/Text/index.tsx", - "name": "TextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Text/index.tsx", - "name": "TextOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "variant": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Text/index.tsx", - "name": "TextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Text/index.tsx", - "name": "TextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"h0\" | \"lg\" | \"md\" | \"sm\" | \"xs\" | \"subtitle-md\" | \"subtitle-sm\"", - "value": [ - { - "value": "\"h1\"" - }, - { - "value": "\"h2\"" - }, - { - "value": "\"h3\"" - }, - { - "value": "\"h4\"" - }, - { - "value": "\"h5\"" - }, - { - "value": "\"h6\"" - }, - { - "value": "\"h0\"" - }, - { - "value": "\"lg\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"xs\"" - }, - { - "value": "\"subtitle-md\"" - }, - { - "value": "\"subtitle-sm\"" - } - ] - } - }, - "withDash": { - "defaultValue": null, - "description": "", - "name": "withDash", - "parent": { - "fileName": "lib/src/components/Text/index.tsx", - "name": "TextOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Text/index.tsx", - "name": "TextOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Textarea/docs/properties.json b/lib/src/components/Textarea/docs/properties.json deleted file mode 100644 index 5d7eeb23f..000000000 --- a/lib/src/components/Textarea/docs/properties.json +++ /dev/null @@ -1,235 +0,0 @@ -{ - "Textarea": { - "props": { - "autoFocus": { - "defaultValue": null, - "description": "", - "name": "autoFocus", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "maxLength": { - "defaultValue": null, - "description": "", - "name": "maxLength", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "minRows": { - "defaultValue": { - "value": 5 - }, - "description": "", - "name": "minRows", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "(event: ChangeEvent) => void" - } - }, - "onFocus": { - "defaultValue": null, - "description": "", - "name": "onFocus", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onKeyDown": { - "defaultValue": null, - "description": "", - "name": "onKeyDown", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "(event: KeyboardEvent) => void" - } - }, - "placeholder": { - "defaultValue": null, - "description": "", - "name": "placeholder", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "value": { - "defaultValue": null, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Textarea/index.tsx", - "name": "TextareaOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/TimePicker/docs/properties.json b/lib/src/components/TimePicker/docs/properties.json deleted file mode 100644 index 1c341734b..000000000 --- a/lib/src/components/TimePicker/docs/properties.json +++ /dev/null @@ -1,241 +0,0 @@ -{ - "TimePicker": { - "props": { - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "welcome-ui/node_modules/@types/react-datepicker/index.d.ts", - "name": "ReactDatePickerProps" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@types/react-datepicker/index.d.ts", - "name": "ReactDatePickerProps" - }, - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "(string | ReactElement>) & Element", - "value": [ - { - "value": "string & Element" - }, - { - "value": "ReactElement> & Element" - } - ] - } - }, - "iconPlacement": { - "defaultValue": { - "value": "left" - }, - "description": "", - "name": "iconPlacement", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "IconPlacement", - "value": [ - { - "value": "\"right\"" - }, - { - "value": "\"left\"" - } - ] - } - }, - "onBlur": { - "defaultValue": null, - "description": "", - "name": "onBlur", - "parent": { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "(date?: Date) => void" - } - }, - "onFocus": { - "defaultValue": null, - "description": "", - "name": "onFocus", - "parent": { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "(event: FocusEvent) => void" - } - }, - "placeholder": { - "defaultValue": null, - "description": "", - "name": "placeholder", - "parent": { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/DateTimePickerCommon/CustomInput.tsx", - "name": "CustomInputOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - } - ] - } - }, - "transparent": { - "defaultValue": null, - "description": "", - "name": "transparent", - "parent": { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "value": { - "defaultValue": { - "value": "new Date()" - }, - "description": "", - "name": "value", - "parent": { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/TimePicker/index.tsx", - "name": "TimePickerOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "string | Date", - "value": [ - { - "value": "string" - }, - { - "value": "Date", - "description": "Enables basic storage and retrieval of dates and times.", - "fullComment": "Enables basic storage and retrieval of dates and times.", - "tags": {} - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Toast/docs/properties.json b/lib/src/components/Toast/docs/properties.json deleted file mode 100644 index 1fb60d9f0..000000000 --- a/lib/src/components/Toast/docs/properties.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "Toast.Snackbar": { - "props": { - "cta": { - "defaultValue": null, - "description": "add correct separator for call to action\nuse SnackbarAction", - "name": "cta", - "parent": { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "hasCloseButton": { - "defaultValue": { - "value": true - }, - "description": "", - "name": "hasCloseButton", - "parent": { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "onClose": { - "defaultValue": null, - "description": "", - "name": "onClose", - "parent": { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - } - ], - "required": false, - "type": { - "name": "() => void" - } - }, - "variant": { - "defaultValue": { - "value": "default" - }, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Toast/Snackbar.tsx", - "name": "SnackbarOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "\"default\" | \"info\" | \"success\" | \"danger\" | \"warning\"", - "value": [ - { - "value": "\"default\"" - }, - { - "value": "\"info\"" - }, - { - "value": "\"success\"" - }, - { - "value": "\"danger\"" - }, - { - "value": "\"warning\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Toggle/docs/properties.json b/lib/src/components/Toggle/docs/properties.json deleted file mode 100644 index 5ce1cfb29..000000000 --- a/lib/src/components/Toggle/docs/properties.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "Toggle": { - "props": { - "checked": { - "defaultValue": null, - "description": "", - "name": "checked", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "disabled": { - "defaultValue": null, - "description": "", - "name": "disabled", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "boolean", - "value": [ - { - "value": "false" - }, - { - "value": "true" - } - ] - } - }, - "name": { - "defaultValue": null, - "description": "", - "name": "name", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "string" - } - }, - "onChange": { - "defaultValue": null, - "description": "", - "name": "onChange", - "parent": { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/Checkbox/index.tsx", - "name": "CheckboxOptions" - } - ], - "required": false, - "type": { - "name": "(event: ChangeEvent) => void" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/Tooltip/docs/properties.json b/lib/src/components/Tooltip/docs/properties.json deleted file mode 100644 index 7e273075e..000000000 --- a/lib/src/components/Tooltip/docs/properties.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "Tooltip": { - "props": { - "gutter": { - "defaultValue": { - "value": 8 - }, - "description": "The distance between the popover and the anchor element.\n\nLive examples:\n- [Combobox filtering](https://ariakit.org/examples/combobox-filtering)\n- [Form with Select](https://ariakit.org/examples/form-select)\n- [Hovercard with keyboard support](https://ariakit.org/examples/hovercard-disclosure)\n- [MenuItemRadio](https://ariakit.org/examples/menu-item-radio)\n- [Submenu](https://ariakit.org/examples/menu-nested)\n- [Toolbar with Select](https://ariakit.org/examples/toolbar-select)", - "name": "gutter", - "parent": { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tooltip/tooltip.d.ts", - "name": "TooltipOptions" - }, - "declarations": [ - { - "fileName": "welcome-ui/node_modules/@ariakit/react-core/cjs/tooltip/tooltip.d.ts", - "name": "TooltipOptions" - } - ], - "required": false, - "type": { - "name": "number" - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/VariantIcon/docs/properties.json b/lib/src/components/VariantIcon/docs/properties.json deleted file mode 100644 index 6f3cec03b..000000000 --- a/lib/src/components/VariantIcon/docs/properties.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "VariantIcon": { - "props": { - "icon": { - "defaultValue": null, - "description": "", - "name": "icon", - "parent": { - "fileName": "lib/src/components/VariantIcon/index.tsx", - "name": "VariantIconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/VariantIcon/index.tsx", - "name": "VariantIconOptions" - } - ], - "required": false, - "type": { - "name": "Element" - } - }, - "size": { - "defaultValue": { - "value": "md" - }, - "description": "", - "name": "size", - "parent": { - "fileName": "lib/src/components/VariantIcon/index.tsx", - "name": "VariantIconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/VariantIcon/index.tsx", - "name": "VariantIconOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Size", - "value": [ - { - "value": "\"xs\"" - }, - { - "value": "\"sm\"" - }, - { - "value": "\"md\"" - }, - { - "value": "\"lg\"" - }, - { - "value": "\"xl\"" - }, - { - "value": "\"xxl\"" - } - ] - } - }, - "variant": { - "defaultValue": null, - "description": "", - "name": "variant", - "parent": { - "fileName": "lib/src/components/VariantIcon/index.tsx", - "name": "VariantIconOptions" - }, - "declarations": [ - { - "fileName": "lib/src/components/VariantIcon/index.tsx", - "name": "VariantIconOptions" - } - ], - "required": false, - "type": { - "name": "enum", - "raw": "Variant", - "value": [ - { - "value": "\"danger\"" - }, - { - "value": "\"warning\"" - }, - { - "value": "\"success\"" - }, - { - "value": "\"info\"" - }, - { - "value": "\"default\"" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/lib/src/components/WelcomeLoader/docs/properties.json b/lib/src/components/WelcomeLoader/docs/properties.json deleted file mode 100644 index e701a26f0..000000000 --- a/lib/src/components/WelcomeLoader/docs/properties.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "WelcomeLoader": { - "props": {} - } -} \ No newline at end of file diff --git a/lib/vite.config.mjs b/lib/vite.config.mjs index d0851bf09..6d7c398bc 100644 --- a/lib/vite.config.mjs +++ b/lib/vite.config.mjs @@ -7,7 +7,6 @@ import preserveDirectives from 'rollup-preserve-directives' import { generateWebsiteExamplesPlugin } from './scripts/generate-website-examples' import { getLibEntries } from './scripts/get-lib-entries' -import { generateTypesDoc } from './scripts/generate-types-doc' function addUseClientDirectivePlugin() { return { @@ -50,7 +49,6 @@ export default defineConfig({ preserveDirectives(), addUseClientDirectivePlugin(), generateWebsiteExamplesPlugin(), - generateTypesDoc(), dts({ outDir: 'dist/types', entryRoot: 'src', diff --git a/package.json b/package.json index ee2f5caa7..0132d91e0 100644 --- a/package.json +++ b/package.json @@ -76,7 +76,6 @@ "onchange": "^7.0.2", "postcss-styled-syntax": "^0.6.4", "react": "^18.1.0", - "react-docgen-typescript": "^2.2.2", "react-dom": "^18.1.0", "react-router-dom": "6.27.0", "release-it": "^18.1.1", diff --git a/website/app/components/[id]/[subPage]/code.tsx b/website/app/components/[id]/[subPage]/code.tsx deleted file mode 100644 index 8fc5d9d21..000000000 --- a/website/app/components/[id]/[subPage]/code.tsx +++ /dev/null @@ -1,46 +0,0 @@ -import { notFound } from 'next/navigation' - -import { PageProps } from './page' - -import { Mdx } from '~/build-app/components/Mdx' -import { TableOfContent } from '~/build-app/components/TableOfContent' -import { getPageContent } from '~/build-app/utils/page-content' -import { getPages, getStaticParams } from '~/build-app/utils/pages-components' -import { Installation } from '~/build-app/components/Installation' -import { getRepository } from '~/build-app/utils/transform-name' - -export async function generateStaticParams() { - const pages = getPages() - - return getStaticParams(pages) -} - -const Page = ({ params }: PageProps) => { - const { id } = params - const componentName = getRepository(id) - - const { contentWithoutMatter, data, isNotFound, tree } = getPageContent({ - filename: `${componentName}/docs/index.mdx`, - isPackage: true, - }) - - if (isNotFound) return notFound() - - return ( - <> -
- {`
`} - - ## Examples - {contentWithoutMatter} -
- - - ) -} - -export default Page diff --git a/website/app/components/[id]/[subPage]/other.tsx b/website/app/components/[id]/[subPage]/other.tsx deleted file mode 100644 index 27a064236..000000000 --- a/website/app/components/[id]/[subPage]/other.tsx +++ /dev/null @@ -1,35 +0,0 @@ -import { notFound } from 'next/navigation' - -import { PageProps } from './page' - -import { Mdx } from '~/build-app/components/Mdx' -import { TableOfContent } from '~/build-app/components/TableOfContent' -import { getPageContent } from '~/build-app/utils/page-content' -import { getPages, getStaticParams } from '~/build-app/utils/pages-components' - -export async function generateStaticParams() { - const pages = getPages() - - return getStaticParams(pages) -} - -const Page = ({ params }: PageProps) => { - const { id, subPage } = params - - const { contentWithoutMatter, isNotFound, tree } = getPageContent({ - filename: `components/${id}/${subPage}.mdx`, - }) - - if (isNotFound) return notFound() - - return ( - <> -
- {contentWithoutMatter} -
- - - ) -} - -export default Page diff --git a/website/app/components/[id]/[subPage]/page.tsx b/website/app/components/[id]/[subPage]/page.tsx deleted file mode 100644 index 5d356c1ad..000000000 --- a/website/app/components/[id]/[subPage]/page.tsx +++ /dev/null @@ -1,30 +0,0 @@ -import CodePage from './code' -import OtherPage from './other' -import PropsPage from './props' - -import { getPages, getStaticParams } from '~/build-app/utils/pages-components' - -export type PageProps = { - params: { - id: string - subPage?: string - } -} - -export async function generateStaticParams() { - const pages = getPages() - - return getStaticParams(pages) -} - -const Page = ({ params }: PageProps) => { - const { subPage } = params - - if (subPage === 'code') return - - if (subPage === 'props') return - - return -} - -export default Page diff --git a/website/app/components/[id]/page.tsx b/website/app/components/[id]/page.tsx index 45e6b91a4..1ff224138 100644 --- a/website/app/components/[id]/page.tsx +++ b/website/app/components/[id]/page.tsx @@ -1,14 +1,13 @@ import { notFound } from 'next/navigation' -import CodePage from './[subPage]/code' - import { Mdx } from '~/build-app/components/Mdx' import { TableOfContent } from '~/build-app/components/TableOfContent' import { getPageContent } from '~/build-app/utils/page-content' import { getPages, getStaticParams } from '~/build-app/utils/pages-components' +import { Installation } from '~/build-app/components/Installation' import { getRepository } from '~/build-app/utils/transform-name' -type PageProps = { +export type PageProps = { params: { id: string } @@ -22,26 +21,25 @@ export async function generateStaticParams() { const Page = ({ params }: PageProps) => { const { id } = params + const componentName = getRepository(id) - const { contentWithoutMatter, isNotFound, tree } = getPageContent({ - filename: `components/${id}/overview.mdx`, + const { contentWithoutMatter, data, isNotFound, tree } = getPageContent({ + filename: `${componentName}/docs/index.mdx`, + isPackage: true, }) - if (isNotFound) { - const { isNotFound: componentsNotFound } = getPageContent({ - filename: `${getRepository(id)}/docs/index.mdx`, - isPackage: true, - }) - - if (componentsNotFound) return notFound() - - return - } + if (isNotFound) return notFound() return ( <>
- overview example + {`
`} + + ## Examples {contentWithoutMatter}
diff --git a/website/app/components/[id]/[subPage]/props.tsx b/website/app/components/[id]/props/page.tsx similarity index 80% rename from website/app/components/[id]/[subPage]/props.tsx rename to website/app/components/[id]/props/page.tsx index 9a8caae70..e63e9f687 100644 --- a/website/app/components/[id]/[subPage]/props.tsx +++ b/website/app/components/[id]/props/page.tsx @@ -1,8 +1,8 @@ import { notFound } from 'next/navigation' -import { PageProps } from './page' +import { PageProps } from '../page' -import { Properties } from '~/build-app/components/Props' +import { Properties, PropertiesProps } from '~/build-app/components/Props' import { TableOfContent } from '~/build-app/components/TableOfContent' import { getComponentProperties } from '~/build-app/utils/components-properties' import { getPropertiesTree } from '~/build-app/utils/page-tree' @@ -17,7 +17,7 @@ export async function generateStaticParams() { const Page = ({ params }: PageProps) => { const { id } = params - const properties = getComponentProperties(getRepository(id)) + const properties = getComponentProperties(getRepository(id)) as PropertiesProps['items'] if (!properties) return notFound() diff --git a/website/build-app/utils/components-properties.ts b/website/build-app/utils/components-properties.ts index 2799052da..38b9e8d8b 100644 --- a/website/build-app/utils/components-properties.ts +++ b/website/build-app/utils/components-properties.ts @@ -1,22 +1,126 @@ -import { existsSync, readFileSync } from 'fs' -import { join } from 'path' +import { readdirSync } from 'fs' +import { join, resolve } from 'path' + +import * as docgen from 'react-docgen-typescript' + +const tsConfigPath = join(process.cwd(), 'tsconfig.json') + +const shouldDisplayPropsFiles = [ + 'lib/src/dist/types/utils/field-styles.d.ts', + 'lib/src/dist/types/components/Button/index.d.ts', + 'lib/src/dist/types/components/InputText/index.d.ts', + 'lib/node_modules/ariakit/ts/Tab/TabStore.d.ts', +] + +// Get only ComponentOptions declarations for prevent all WuiProps +const propFilter = (prop: docgen.PropItem) => { + if (prop.declarations?.length > 0) { + const isOptionDeclaration = prop.declarations.find(declaration => { + if (declaration.name.includes('Options')) return true + + return shouldDisplayPropsFiles.includes(declaration.fileName) + }) + + return Boolean(isOptionDeclaration) + } + + return true +} + +const { parse } = docgen.withCustomConfig(tsConfigPath, { + propFilter, + shouldRemoveUndefinedFromOptional: true, + shouldExtractValuesFromUnion: true, +}) + +const isComponentFile = (file: string) => { + if (file === 'index.tsx') { + return true + } + + const [name, extension] = file.split('.') + const firstLetter = name[0] + + // Components start with capital letter e.g. Title.js + if (extension === 'tsx' && firstLetter === firstLetter.toUpperCase()) { + return true + } + + return false +} + +// Get all files in a component folder +const getComponentFiles = (folder: string) => { + const componentFiles = readdirSync(folder) + + return componentFiles.filter(isComponentFile) +} + +// Get definitions from file +const getFileDefinitions = (absolutePath: string) => { + const definitions = parse(absolutePath) + + return definitions +} + +// check if props entries are empty +const arePropsEmpty = (obj: { + [name: string]: { props: Record; tag: string } +}) => { + // Helper function to check if an object is empty + const isEmptyObject = (obj: unknown) => { + return obj && typeof obj === 'object' && Object.keys(obj).length === 0 + } + + // Iterate through all keys in the object + // eslint-disable-next-line @typescript-eslint/no-unused-vars + return Object.entries(obj).every(([_, value]) => { + // If there's a props object, check if it's empty + if (value && typeof value === 'object' && 'props' in value) { + return isEmptyObject(value.props) + } + return true // If no props object, consider it valid + }) +} export function getComponentProperties(component: string) { - const file = join( - process.cwd(), - '../', - 'lib', - 'src', - 'components', - component, - 'docs', - 'properties.json' - ) - const fileExist = existsSync(file) - - if (!fileExist) return null - - const properties = readFileSync(file, 'utf8') - - return JSON.parse(properties) + const parentDirectory = resolve(process.cwd(), '../', 'lib/src/components') + const componentDir = resolve(parentDirectory, component) + + // Get all files in each component folder + const files = getComponentFiles(componentDir) + + // Get definitions from each file + const componentProps: { + [name: string]: { props: Record; tag: string } + } = {} + + files.forEach(file => { + const absolutePath = join(componentDir, file) + const definitions = getFileDefinitions(`${absolutePath}`) + + definitions.forEach(definition => { + const { displayName, props, tags } = definition + const name = tags?.name || displayName + + if (props) { + componentProps[name] = { + tag: tags?.tag, + props: Object.keys(props) + .sort() + .reduce((obj: Record, key) => { + obj[key] = props[key] + return obj + }, {}), + } + } + }) + }) + + // Check before if has no props no avoid showing empty props page + if (!arePropsEmpty(componentProps)) { + return componentProps + } + + return null } diff --git a/website/build-app/utils/examples-page-exporter.ts b/website/build-app/utils/examples-page-exporter.ts deleted file mode 100644 index ed0fac43d..000000000 --- a/website/build-app/utils/examples-page-exporter.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { existsSync, readdirSync, writeFileSync } from 'fs' -import { join } from 'path' - -function getExamplesPages() { - const dir = join(process.cwd(), 'lib/src') - const dirExist = existsSync(dir) - const examples = [] - - if (!dirExist) return - - const folderList = readdirSync(dir) - - for (const folder of folderList) { - const subFolder = join(process.cwd(), 'lib/src', folder, 'docs', 'examples') - const subFolderExist = existsSync(subFolder) - - if (!subFolderExist) continue - - const fileList = readdirSync(subFolder) - - for (const file of fileList) { - examples.push(`${subFolder}/${file}`.split('src')[1]) - } - } - - const fileContent = `/* eslint-disable */\n/** WARNING\nThis file is auto-generate with yarn watch command, do not change it directly!\n**/\n\nimport dynamic from "next/dynamic";\n\nexport default {\n${examples - .map( - path => - ` "${path}": dynamic(() => import("../../packages${path}").then(mod => mod), { ssr: false })` - ) - .join(',\n')}\n};\n` - - writeFileSync(join(process.cwd(), 'website', 'build-app', 'examples.js'), fileContent) -} - -getExamplesPages() diff --git a/website/build-app/utils/pages-components.ts b/website/build-app/utils/pages-components.ts index ca4100603..bf5c1c237 100644 --- a/website/build-app/utils/pages-components.ts +++ b/website/build-app/utils/pages-components.ts @@ -5,43 +5,9 @@ import matter from 'gray-matter' import kebabCase from 'lodash/kebabCase' import { PageTree } from '../types' -import { replaceMdxRegex } from '../constants/regex' - -import { getComponentProperties } from './components-properties' -import { getRepository } from './transform-name' type Parent = 'components' -function getComponentSubPages(id: string) { - const directory = `build-app/pages/components/${id}` - const folder = join(process.cwd(), directory) - const folderExist = existsSync(folder) - - if (!folderExist) { - const withProperties = getComponentProperties(getRepository(id)) - - if (withProperties) { - return ['props'] - } - - return [] - } - - const subPages = [] - - const fileList = readdirSync(folder) - - for (const file of fileList) { - const fileName = file.replace(replaceMdxRegex, '') - - if (fileName !== 'overview') { - subPages.push(fileName) - } - } - - return [...subPages, 'code', 'props'] -} - export function getFilesFromPackages(selectedParent: Parent) { const folder = join(process.cwd(), '../lib/src/components') // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -64,7 +30,7 @@ export function getFilesFromPackages(selectedParent: Parent) { const categoryParent = files.filter(resultItem => resultItem.category === category)[0] - const newChild = { id: fileKebabCase, title, subPages: getComponentSubPages(fileKebabCase) } + const newChild = { id: fileKebabCase, title, subPages: ['props'] } if (categoryParent) { categoryParent.pages.push(newChild) diff --git a/website/package.json b/website/package.json index 15f06b55c..a59583789 100644 --- a/website/package.json +++ b/website/package.json @@ -25,6 +25,7 @@ "prism-react-renderer": "2.4.0", "prop-types": "^15.8.1", "react": "18.3.1", + "react-docgen-typescript": "^2.2.2", "react-dom": "18.3.1", "react-markdown": "9.0.1", "rehype-parse": "9.0.0",