# Table of contents - [Overview](#overview) - [List of components](#list-of-components) - [getURL](#geturl) - [InvalidType](#invalidtype) - [getStoryTitle](#getstorytitle) - [repositoryActions](#repositoryactions) - [ComponentStats](#componentstats) - [MockContext](#mockcontext) - [ThemeProvider](#themeprovider) - [Playground](#playground) - [Pagination](#pagination) - [PackageVersion](#packageversion) - [BlockContextProvider](#blockcontextprovider) - [Subtitle](#subtitle) - [LocalImport](#localimport) - [Search](#search) - [StoryPlayground](#storyplayground) - [LocalDependencies](#localdependencies) - [ExternalDependencies](#externaldependencies) - [getUpdatedUrlParams](#getupdatedurlparams) - [ComponentContributors](#componentcontributors) - [PageTypeTag](#pagetypetag) - [Title](#title) - [EditPage](#editpage) - [getStoryBlockTitle](#getstoryblocktitle) - [ComponentJSX](#componentjsx) - [CommitsPopover](#commitspopover) - [Description](#description) - [ComponentsContainer](#componentscontainer) - [StoryBlockContainer](#storyblockcontainer) - [DocumentItem](#documentitem) - [makeDecorators](#makedecorators) - [StoryData](#storydata) - [ComponentSource](#componentsource) - [ComponentCommits](#componentcommits) - [BaseTestsCoverage](#basetestscoverage) - [TestsCoverage](#testscoverage) - [TestsResults](#testsresults) - [PackageLink](#packagelink) - [Stories](#stories) - [StoryConfig](#storyconfig) - [Container](#container) - [BaseComponentCommits](#basecomponentcommits) - [TagsList](#tagslist) - [BaseStoryData](#basestorydata) - [BaseTestsResults](#basetestsresults) - [StorySource](#storysource) - [PropsTable](#propstable) - [getUrlParams](#geturlparams) - [ComponentsBlockContainer](#componentsblockcontainer) - [BasePlayground](#baseplayground) - [useURLParams](#useurlparams) # Overview Some of the guiding design goals for this library: - Most components should have a 'plain' and a 'block' version, where the block version adds a collapsible Box with a title. - There are two main categories of components: - that display story data (i.e. story source, story render) - that display component(s) data (i.e. prop tables, component sources) - Components accept a list of custom ActionItems to be extended. - Components that deal with source code (story or component source) display actions to browse their respective repositories. # List of components ## getURL **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/utils/url.ts](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/url.ts#L3)_ ## InvalidType **`react component`** error message when the control type is not found. _defined in [@component-controls/blocks/ui/blocks/src/notifications/InvalidType.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/notifications/InvalidType.tsx#L6)_ ## getStoryTitle **`react type`** _defined in [@component-controls/blocks/ui/blocks/src/utils/constants.ts](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/constants.ts#L5)_ **properties** | Name | Type | Parent | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `title*` | `string` | `Document` | title of the document. If no 'route' parameter is specifified, the title is used to generate the document url. This is the only required field, to show the document in the menu structures. | | `type` | `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string` | `Document` | document type - blogs, pages, stories and even custom ones. By default - story | | `route` | `string` | `Document` | if provided, will be used as the route for the page. if not provided, the title in lowercase will be used as the route | | `date` | `string` | `Document` | optional date the document was created. If not assigned, the instrumentation process will use birthtime | | `dateModified` | `string` | `Document` | optional date the document was last modified. If not assigned, the instrumentation process will use mtime | | `status` | `"draft"` \| `"published"` | `Document` | if set to draft, the document will be hidden in production builds. | | `tags` | `string`\[] | `Document` | comma-separated list of document tags, used for search and for SOE keywords unless keyswords are specified. | | `keywords` | `string`\[] | `Document` | comma-separated list of SEO keywords | | `description` | `string` \| `JSX.Element` | `Document` | documentation file description | | `image` | `string` | `Document` | link to an image for the document, will be used for SEO | | `author` | `string` | `Document` | document author | | `order` | `number` | `Document` | document order, used to sort documents within the same parent | | `menu` | `string` | `Document` | to which static menu to attach the document compatibility with docz | | `template` |
`type`
`bind`\*: **function** (
`props`
`name`\*: `string`
`storyName`: `string`
`id`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: StoryRenderFn
`description`: `string`
`arguments`: StoryArguments
`loc`: CodeLocation
`source`: `string`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`
`at`\*:
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`: ComponentControls
`smartControls`: SmartControls
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
) =>
`Example`<>
`bind`\*: **function** (
`props`\*:
) => `Example`<`Props`>
`source`: `string`
`id`: `string`
`description`: `string`
`storyName`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: StoryRenderFn
`loc`: CodeLocation
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`
`at`\*:
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`smartControls`: SmartControls
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
`controls`\*:

`source`: `string`
`id`: `string`
`description`: `string`
`storyName`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: **function** (
`controlValues`
\[`string`]: `any`
`context`: `any`
) => `Promise` \| `any`
`loc`
`start`\*
`line`\*: `number`
`column`\*: `number`
`end`\*
`line`\*: `number`
`column`\*: `number`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`smartControls`
`smart`: `boolean`
`include`: `string`\[] \| `IncludeFn`
`exclude`: `string`\[] \| `IncludeFn`
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
`controls`
\[`string`]: `ComponentControl`<`ExampleControls`> \| `any`
| `Document` | template component to be linked to document stories | | `stories` | `string`\[] | `Document` | list of story ids contained in the document. | | `source` | `string` | `Document` | source code of the entire file of stories | | `fileName` | `string` | `Document` | file name of the file of stories | | `package` | `string` | `Document` | lookup into the global store of PackageInfo package.json | | `testFiles` | `string`\[] | `Document` | optional specify which test files are asociated with the document | | `testCoverage` | `string`\[] | `Document` | optional specify which files to use for test coverage | | `testData` | `string` | `Document` | optional test data file | | `renderFn` | **function** (
`props`\*
`story`\*
`name`\*: `string`
`storyName`: `string`
`id`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: StoryRenderFn
`description`: `string`
`arguments`: StoryArguments
`loc`: CodeLocation
`source`: `string`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`: ComponentControls
`smartControls`: SmartControls
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
`doc`
`title`\*:
`type`\*:
`route`\*:
`date`\*:
`dateModified`\*:
`status`\*:
`tags`\*:
`keywords`\*:
`description`\*:
`image`\*:
`author`\*:
`order`\*:
`menu`\*:
`template`\*:
`stories`\*:
`source`\*:
`fileName`\*:
`package`\*:
`testFiles`\*:
`testCoverage`\*:
`testData`\*:
`renderFn`\*:
`data`\*:
`componentsLookup`\*:
`MDXPage`\*:
`isMDXComponent`\*:
`parameters`\*:
`component`\*:
`subcomponents`\*:
`controls`\*:
`smartControls`\*:
`decorators`\*:
`plugins`\*:
`category`\*:
`navSidebar`\*:
`contextSidebar`\*:
`fullPage`\*:
`values`: ExampleControls
`options`: `any`
) => `any` | `Document` | render function by framework. By default 'react' | | `data` |
`DocumentData`
\[`string`]:
`type`
\[`string`]: `ComponentControl`<`ExampleControls`> \| `any`
| `Document` | records of storyid/data pairs, to be associated with documents | | `componentsLookup` |
`type`
\[`string`]: `string`
| `Document` | lookup into the global store.components since multiple components of the same name can be used example: \['Button']: 'c:/myapp/Button.tsx' | | `MDXPage` | `any` | `Document` | for MDX documents, this is an MDXContent function, to be rendered inside a MDXProvider | | `isMDXComponent` | `boolean` | `Document` | custom prop set by mdxjs | | `parameters` | `any` | `Document` | storybook compatibility field | | `component` | `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`> | `StoryProps` | id for component associated with the story | | `subcomponents` | `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)> | `StoryProps` | multiple components option | | `controls` |
`ComponentControls`<>
\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<> \| `ComponentControlButton`<> \| `ComponentControlOptions`<> \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`
| `StoryProps` | ComponentControls are defined in key value pairs the name of the property is the key and the value is the ComponentControl | | `smartControls` |
`SmartControls`
`smart`: `boolean`
`include`: `string`\[] \| `IncludeFn`
`exclude`: `string`\[] \| `IncludeFn`
| `StoryProps` | "smart" controls options | | `decorators` | `StoryRenderFn`\[] | `StoryProps` | array of wrapper functions (decorators) to be called when rendering each individual story. | | `plugins` | `any` | `StoryProps` | plugins configuration settings | | `category` | `string` | `StoryProps` | category string - can be used for cleanly separating stories/components | | `navSidebar` | `boolean` | `PageLayoutProps` | whether to add navigation sidebar to the page | | `contextSidebar` | `boolean` | `PageLayoutProps` | whether to add conext sidebar to navigate the sections of the current document | | `fullPage` | `boolean` | `PageLayoutProps` | whether to take a fullpage theme option | ## repositoryActions **`react function`** _defined in [@component-controls/blocks/ui/blocks/src/utils/repositoryActions.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/repositoryActions.tsx#L5)_ **parameters** | Name | Type | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `packageInfo` |
`PackageInfo`
`fileHash`\*: `string`
`name`: `string`
`version`: `string`
`dependencies`
\[`string`]: `PackageDependency`
`devDependencies`
\[`string`]: `PackageDependency`
`peerDependencies`
\[`string`]: `PackageDependency`
`privateNpm`: `boolean`
`repository`\*
`browse`: `string`
`docs`: `string`
`issues`: `string`
| package.json information about the repository of the stories and components | | `returns` | `ActionItem`\[] \| `undefined` | | ## ComponentStats **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/ComponentStats/ComponentStats.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentStats/ComponentStats.tsx#L7)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `component` |
`Component`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| | component specified for stories or story files | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | ## MockContext **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/test/MockContext.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/test/MockContext.tsx#L12)_ **properties** | Name | Type | Parent | Default | | ----------- | -------------------------------------------- | ----------------- | --------------- | | `key*` | \[`string`]: `any`
| | | | `storyId` | `string` | `MockContexProps` | `"id-of-story"` | | `component` | `ComponentClass` \| `FunctionComponent`<> | `MockContexProps` | | ## ThemeProvider **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/ThemeProvider/ThemeProvider.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ThemeProvider/ThemeProvider.tsx#L9)_ **properties** | Name | Type | Parent | Description | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | --------------------------------------------- | | `components` |
`MarkdownComponentType`
\[`string`]: `ComponentClass` \| `FunctionComponent`<>
| `ThemeProviderProps` | components to customize the markdown display. | ## Playground **`react component`** Component to display a live playground of component examples. Has custom actions for zooming, switch direction, review story source and configuration. _defined in [@component-controls/blocks/ui/blocks/src/Playground/Playground.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Playground/Playground.tsx#L8)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `scale` | `number` | `PlaygroundOwnProps` | default scale for the zoom feature. If scale is set to 0, the zoom feature will be disabled. | | `source` | `string` | `PlaygroundOwnProps` | playground source option - valid when a Story is not embedded inside the Playground. | | `dark` | `boolean` | `PlaygroundOwnProps` | whether to use the dark theme for the story source component. | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `openTab` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `PanelContainerOwnProps` | by default, which tab to have open. | | `visibleTabs` | `boolean` | `PanelContainerOwnProps` | if true, the tabs on the panels will be visible | | `background` | `"dark"` \| `"light"` | `PanelContainerOwnProps` | background pattern type | | `direction` | `"ltr"` \| `"rtl"` | `PanelContainerOwnProps` | direction type | | `actions` | `ActionItem`\[] | `ActionContainerProps` | optional actions provided to the component | ## Pagination **`react component`** displays automatic pagination to the next/previous document of this same type. _defined in [@component-controls/blocks/ui/blocks/src/Pagination/Pagination.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Pagination/Pagination.tsx#L13)_ ## PackageVersion **`react component`** Display a label with the component's package version. extracted from package.json _defined in [@component-controls/blocks/ui/blocks/src/PackageLink/PackageVersion.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PackageLink/PackageVersion.tsx#L16)_ **properties** | Name | Type | Parent | Description | | ------ | -------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | ## BlockContextProvider **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/context/BlockContext.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/context/BlockContext.tsx#L9)_ **properties** | Name | Type | Parent | Description | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | `storyId` | `string` | `StateRootProps` | current story id | | `docId` | `string` | `StateRootProps` | current documentation page, if no story is selected | | `store*` |
`Store`
`error`: `string`
`config`\*
`footer`
`left`: ActionItems
`right`: ActionItems
`menu`: `StaticMenuItem`\[]
`title`: `string`
`image`: `string`
`toolbar`
`left`: ActionItems
`right`: ActionItems
`components`: `Record`<`string`, `unknown`>
`description`: `string`
`controls`
\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<`P`> \| `ComponentControlButton` \| `ComponentControlOptions` \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`
`author`: `string`
`component`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`smartControls`
`smart`: `boolean`
`include`: `string`\[] \| `IncludeFn`
`exclude`: `string`\[] \| `IncludeFn`
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
`theme`
\[`string`]: `any`
`language`: `string`
`logo`: `string` \| `ReactNode`
`app`
`propTypes`: `WeakValidationMap`<`P`> \| `undefined`
`contextTypes`: `ValidationMap`<`any`> \| `undefined`
`defaultProps`: `Partial`<`P`> \| `undefined`
`displayName`: `string` \| `undefined`
`copyright`: `string`
`links`: (`DetailedHTMLProps`<>)\[]
`seo`: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`
`pages`
\[`string`]:
`type`
`basePath`\*:
`sideNav`\*:
`label`\*:
`indexHome`\*:
`topMenu`\*:
`container`\*:
`tabs`\*:
`navSidebar`\*:
`contextSidebar`\*:
`fullPage`\*:
`storySort`: **function** (
`a`\*: `string`
`b`\*: `string`
) => `number`
`sidebar`: `ActionItem`\[]
`analytics`: `any`
`renderFn`: **function** (
`props`\*
`story`\*
`name`\*:
`storyName`\*:
`id`\*:
`rawId`\*:
`doc`\*:
`storyFn`\*:
`description`\*:
`arguments`\*:
`loc`\*:
`source`\*:
`subtitle`\*:
`dynamic`\*:
`dynamicId`\*:
`component`\*:
`subcomponents`\*:
`controls`\*:
`smartControls`\*:
`decorators`\*:
`plugins`\*:
`category`\*:
`doc`: Document
`values`: ExampleControls
`options`: `any`
) => `any`
`search`
`indexingModule`: `string`
`searchingModule`\*: `string`
`fields`: `SearchFields`\[]
`emptySearchDocuments`: `string`\[]
`hitsPerPage`: `number`
`options`: `any`
`ignore`: `string`\[]
`webpack`: `Configuration` \| `WebpackConfigFn`
`finalWebpack`: `Configuration` \| `WebpackConfigFn`
`presets`: `RuleType`\[]
`configPath`: `string`
`distFolder`: `string`
`bundleName`: `string`
`staticFolder`: `string`
`cssFileName`: `string`
`logOptions`: `Partial`<`LogOptions`>
`mode`: `"none"` \| `"development"` \| `"production"`
`loaders`
`at`\*: **function** (
`index`\*:
) => `T` \| `undefined`
`module`: `string`
`ident`: `string`
`loader`: `string`
`options`: `string` \| `type`
`stories`: `string` \| `string`\[]
`files`: `string` \| `string`\[]
`siteRoot`: `string`
`categories`: `DocType`\[]
`siteMap`: `type` \| `boolean`
`siteUrl`: `string`
`instrument`: `any`
`tokens`
`figmaAccessToken`: `string`
`githubAccessToken`: `string`
`docs`\*
\[`string`]:
`type`
\[`string`]: `any`
`title`\*: `string`
`type`: DocType
`route`: `string`
`date`: `string`
`dateModified`: `string`
`status`: `"draft"` \| `"published"`
`tags`: `string`\[]
`keywords`: `string`\[]
`description`: `string` \| `JSX.Element`
`image`: `string`
`author`: `string`
`order`: `number`
`menu`: `string`
`template`
`bind`\*:
`source`\*:
`id`\*:
`description`\*:
`storyName`\*:
`rawId`\*:
`doc`\*:
`storyFn`\*:
`loc`\*:
`subtitle`\*:
`dynamic`\*:
`dynamicId`\*:
`component`\*:
`subcomponents`\*:
`smartControls`\*:
`decorators`\*:
`plugins`\*:
`category`\*:
`controls`\*:
`stories`: `string`\[]
`source`: `string`
`fileName`: `string`
`package`: `string`
`testFiles`: `string`\[]
`testCoverage`: `string`\[]
`testData`: `string`
`renderFn`: **function** (
`props`\*:
) => `any`
`data`
\[`string`]:
`componentsLookup`
\[`string`]: `string`
`MDXPage`: `any`
`isMDXComponent`: `boolean`
`parameters`: `any`
`component`
`at`\*: **function** (
`index`\*:
) => `T` \| `undefined`
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`: ComponentControls
`smartControls`: SmartControls
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
`navSidebar`: `boolean`
`contextSidebar`: `boolean`
`fullPage`: `boolean`
`stories`\*: [`Stories`](#stories)
`components`\*
\[`string`]:
`interface`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*:
`end`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*:
`description`\*:
`props`\*:
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`\*:
`dateModified`\*:
`commits`\*:
`sloc`\*:
`jest`
`results`\*:
`coverage`\*:
`packages`\*
\[`string`]:
`interface`
`fileHash`\*: `string`
`name`: `string`
`version`: `string`
`dependencies`
\[`string`]: PackageDependency
`devDependencies`
\[`string`]: PackageDependency
`peerDependencies`
\[`string`]: PackageDependency
`privateNpm`: `boolean`
`repository`\*
`browse`: `string`
`docs`: `string`
`issues`: `string`
`addObserver`\*: **function** (
`observer`\*: **function** (
`story`: Story
) => `void`
) => `void`
`removeObserver`\*: **function** (
`observer`\*: **function** (
`story`: Story
) => `void`
) => `void`
`updateStory`\*: **function** (
`story`\*
`name`\*: `string`
`storyName`: `string`
`id`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: StoryRenderFn
`description`: `string`
`arguments`: `StoryArgument`\[]
`loc`
`start`\*:
`end`\*:
`source`: `string`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`: `string` \| `Record`<`string`, `unknown`> \| `ElementType`<`Props`>
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`: ComponentControls
`smartControls`: SmartControls
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
) => `void`
`search`: **function** (
`store`\*
`error`\*:
`config`\*:
`docs`\*:
`stories`\*:
`components`\*:
`packages`\*:
`addObserver`\*:
`removeObserver`\*:
`updateStory`\*:
`search`\*:
) =>
`SearchResult`
`items`\*: `SearchItem`\[]
`searchFn`\*: **function** (
`search`\*: `string`
) => `void`
`provider`
`logo`\*: ReactNode
`url`\*: `string`
`name`\*: `string`
| | store object | | `activeTab` | `string` | `StateRootProps` | active page tab | | `values` | `any` | `StateRootProps` | initial control values. usually passed from the url | | `userData` | `Record`<`string`, `any`> | `StateRootProps` | user options passed from container those can be global parameters as well as decorators | | `components` |
`MarkdownComponentType`
\[`string`]: `ComponentClass` \| `FunctionComponent`<>
| `ThemeProviderProps` | components to customize the markdown display. | ## Subtitle **`react component`** displays a subtitle as assigned to the story parameters: or story.subtitle _defined in [@component-controls/blocks/ui/blocks/src/Subtitle/Subtitle.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Subtitle/Subtitle.tsx#L15)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | `StoryInputProps` | | | `name` | `string` | `StoryInputProps` | | | `as` | `"h1"` \| `"h2"` \| `"h3"` \| `"h4"` \| `"h5"` | `SubtitleOwnProps` | DOM node type to render as. By default h3. | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | ## LocalImport **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/PackageLink/LocalImport.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PackageLink/LocalImport.tsx#L14)_ **properties** | Name | Type | Parent | | --------------- | -------- | ------------------ | | `componentHash` | `string` | `LocalImportProps` | | `name*` | `string` | `LocalImportProps` | ## Search **`react component`** search input component connected to the store _defined in [@component-controls/blocks/ui/blocks/src/Search/Search.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Search/Search.tsx#L16)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `form` | `string` \| `undefined` | `InputHTMLAttributes` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` \| `undefined` | `HTMLAttributes` | | | `pattern` | `string` \| `undefined` | `InputHTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `InputHTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `ChangeEventHandler` \| `undefined` | `InputHTMLAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | **function** (
`item`\*: `ItemType`
) => `void` | `SearchInputOwnProps` | on select a search item. | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `list` | `string` \| `undefined` | `InputHTMLAttributes` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `name` | `string` \| `undefined` | `InputHTMLAttributes` | | | `step` | `number` \| `string` \| `undefined` | `InputHTMLAttributes` | | | `size` | `number` \| `undefined` | `InputHTMLAttributes` | | | `multiple` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `disabled` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `height` | `number` \| `string` \| `undefined` | `InputHTMLAttributes` | | | `width` | `number` \| `string` \| `undefined` | `InputHTMLAttributes` | | | `min` | `number` \| `string` \| `undefined` | `InputHTMLAttributes` | | | `max` | `number` \| `string` \| `undefined` | `InputHTMLAttributes` | | | `accept` | `string` \| `undefined` | `InputHTMLAttributes` | | | `type` | `HTMLInputTypeAttribute` \| `undefined` | `InputHTMLAttributes` | | | `alt` | `string` \| `undefined` | `InputHTMLAttributes` | | | `autoComplete` | `string` \| `undefined` | `InputHTMLAttributes` | | | `autoFocus` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `capture` | `boolean` \| `string` \| `undefined` | `InputHTMLAttributes` | | | `checked` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `crossOrigin` | `string` \| `undefined` | `InputHTMLAttributes` | | | `formAction` | `string` \| `undefined` | `InputHTMLAttributes` | | | `formEncType` | `string` \| `undefined` | `InputHTMLAttributes` | | | `formMethod` | `string` \| `undefined` | `InputHTMLAttributes` | | | `formNoValidate` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `formTarget` | `string` \| `undefined` | `InputHTMLAttributes` | | | `maxLength` | `number` \| `undefined` | `InputHTMLAttributes` | | | `minLength` | `number` \| `undefined` | `InputHTMLAttributes` | | | `readOnly` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `required` | `boolean` \| `undefined` | `InputHTMLAttributes` | | | `src` | `string` \| `undefined` | `InputHTMLAttributes` | | | `value` | `string` \| `ReadonlyArray`<`string`> \| `number` \| `undefined` | `InputHTMLAttributes` | | | `popoverProps` |
`PopoverProps`
`arrowVisible`: `boolean`
`tooltip`\*
`arrowRef`\*: `function` \| `type` \| `null`
`tooltipRef`\*: `function` \| `type` \| `null`
`placement`\*: `AutoPlacement` \| `BasePlacement` \| `VariationPlacement`
`getArrowProps`\*: **function** (
`arg`
\[`string`]: `any`
`style`\*:
) =>
`GetArrowPropsArg`
\[`string`]: `any`
`style`\*:

`getTooltipProps`\*: **function** (
`arg`
\[`string`]: `any`
`style`\*:
`onMouseEnter`\*:
`onMouseLeave`\*:
) =>
`GetTooltipPropsArg`
\[`string`]: `any`
`style`\*:
`onMouseEnter`\*:
`onMouseLeave`\*:
`closeOnReferenceHidden`\*: `boolean`
`defaultTooltipShown`\*: `boolean`
`delayHide`\*: `number`
`delayShow`\*: `number`
`followCursor`\*: `boolean`
`getTooltipRef`: `function` \| `type` \| `null`
`getTriggerRef`: `function` \| `type` \| `null`
`modifiers`\*: (`Modifier`<>)\[]
`placement`\*: `AutoPlacement` \| `BasePlacement` \| `VariationPlacement`
`portalContainer`\*: `HTMLElement`
`tooltipShown`: `boolean`
`trigger`\*: `TriggerTypes` \| `TriggerTypes`\[]
`usePortal`\*: `boolean`
`mutationObserverOptions`\*: MutationObserverInit
`onVisibilityChange`\*: **function** (
`tooltipShown`\*: `boolean`
) => `void`
| `SearchInputOwnProps` | customize the popover | | `render` | **function** (
`rendered`\*: `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined`
) => `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `SearchInputOwnProps` | custom renver of the search items popup | ## StoryPlayground **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/Playground/StoryPlayground.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Playground/StoryPlayground.tsx#L11)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `storyProps` | `any` | `StoryPlaygroundProps` | | | `scale` | `number` | `PlaygroundOwnProps` | default scale for the zoom feature. If scale is set to 0, the zoom feature will be disabled. | | `source` | `string` | `PlaygroundOwnProps` | playground source option - valid when a Story is not embedded inside the Playground. | | `dark` | `boolean` | `PlaygroundOwnProps` | whether to use the dark theme for the story source component. | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `openTab` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `PanelContainerOwnProps` | by default, which tab to have open. | | `visibleTabs` | `boolean` | `PanelContainerOwnProps` | if true, the tabs on the panels will be visible | | `background` | `"dark"` \| `"light"` | `PanelContainerOwnProps` | background pattern type | | `direction` | `"ltr"` \| `"rtl"` | `PanelContainerOwnProps` | direction type | | `actions` | `ActionItem`\[] | `ActionContainerProps` | optional actions provided to the component | ## LocalDependencies **`react component`** Displays local dependencies for a component _defined in [@component-controls/blocks/ui/blocks/src/ComponentDependencies/LocalDependencies.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentDependencies/LocalDependencies.tsx#L12)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `visibility` | `"controls"` \| `"info"` \| `"all"` | `ComponentsBlockContainerProps` | component level visibility | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | ## ExternalDependencies **`react component`** Displays external dependencies for a component _defined in [@component-controls/blocks/ui/blocks/src/ComponentDependencies/ExternalDependencies.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentDependencies/ExternalDependencies.tsx#L12)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `visibility` | `"controls"` \| `"info"` \| `"all"` | `ComponentsBlockContainerProps` | component level visibility | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | ## getUpdatedUrlParams **`react function`** _defined in [@component-controls/blocks/ui/blocks/src/utils/url.ts](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/url.ts#L14)_ **parameters** | Name | Type | | ------------ | ----------------------- | | `paremName*` | `string` | | `value` | `string` | | `returns` | `string` \| `undefined` | ## ComponentContributors **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/ComponentContributors/ComponentContributors.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentContributors/ComponentContributors.tsx#L18)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `caption` | `string` | `ComponentContributorsProps` | | | `component` |
`Component`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| `ComponentContributorsProps` | component specified for stories or story files | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `tooltip` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `GithubAvatarProps` | on hover profile box | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `size` | `number` | `GithubAvatarProps` | size in pixels | | `overlap` | `number` | `GithubAvatarProps` | overlap % of the avatars in a list | | `fixedSize` | `boolean` | `GithubAvatarProps` | whether to fix the size of the avataro on hover | | `githubAccessToken` | `string` | `GithubAvatarProps` | to increase access rate for github user profile info | | `maxItems` | `number` | `GithubAvatarListOwnProps` | max number of avatars, then use a '...' | ## PageTypeTag **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/PageTypeTag/PageTypeTag.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PageTypeTag/PageTypeTag.tsx#L20)_ **properties** | Name | Type | Parent | Description | | ------- | ----------------------------------------------------------------------- | ------------------ | ------------------------------------------------------ | | `type*` | `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string` | `PageTypeTagProps` | page type | | `raw` | `string` | `PageTypeTagProps` | raw string - useful for highlighting in search results | ## Title **`react component`** displays a title as assigned to the story document _defined in [@component-controls/blocks/ui/blocks/src/Title/Title.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Title/Title.tsx#L19)_ **properties** | Name | Type | Parent | Default | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contributors` | `boolean` | `TitleProps` | `true` | | | `id` | `string` | `StoryInputProps` | | | | `name` | `string` | `StoryInputProps` | | | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | | `title` | `string` \| `undefined` | `HTMLAttributes` | | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | | `inlist` | `any` | `HTMLAttributes` | | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | | `variant` | `string` | `BoxOwnProps` | | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | ## EditPage **`react component`** Display a Edit this page link to the page source repository. In order for this to work, you need to set up the \`repository\` field in \`package.json\`. _defined in [@component-controls/blocks/ui/blocks/src/EditPage/EditPage.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/EditPage/EditPage.tsx#L14)_ ## getStoryBlockTitle **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/utils/constants.ts](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/constants.ts#L18)_ **properties** | Name | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | `story` |
`Story`<>
`name`\*: `string`
`storyName`: `string`
`id`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: **function** (
`controlValues`
\[`string`]: `any`
`context`: `any`
) => `Promise` \| `any`
`description`: `string`
`arguments`: `StoryArgument`\[]
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`source`: `string`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`
\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<`P`> \| `ComponentControlButton` \| `ComponentControlOptions` \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`
`smartControls`
`smart`: `boolean`
`include`: `string`\[] \| `IncludeFn`
`exclude`: `string`\[] \| `IncludeFn`
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
| Story interface - usually extracted by the AST instrumenting loader | | `title` | `string` | | ## ComponentJSX **`react component`** Displays external dependencies for a component _defined in [@component-controls/blocks/ui/blocks/src/ComponentJSX/ComponentJSX.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentJSX/ComponentJSX.tsx#L17)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `visibility` | `"controls"` \| `"info"` \| `"all"` | `ComponentsBlockContainerProps` | component level visibility | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | ## CommitsPopover **`react component`** link displaying the total commits on a component with a popover on click that will display the list of commits _defined in [@component-controls/blocks/ui/blocks/src/CommitsPopover/CommitsPopover.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/CommitsPopover/CommitsPopover.tsx#L19)_ **properties** | Name | Type | Parent | Description | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ---------------------------------------------- | | `component` |
`Component`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| `CommmitsPopoverProps` | component specified for stories or story files | ## Description **`react component`** Description component with markdown. The 'of' property can specify which component's description to display. _defined in [@component-controls/blocks/ui/blocks/src/Description/Description.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Description/Description.tsx#L20)_ **properties** | Name | Type | Parent | Description | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `components` |
`type`
`a`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`br`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`button`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`code`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`del`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`div`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`em`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`footer`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`input`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`h1`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`h2`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`h3`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`h4`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`h5`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`h6`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`hr`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`img`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`ol`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`p`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`pre`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`span`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`strong`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`sub`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`sup`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`table`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`tbody`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`td`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`th`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`thead`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`tr`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
`ul`: `string` \| `React.ComponentClass` \| `React.SFC`<> \| `type`
\[`string`]: `ComponentOverride` \| `undefined`
| `MarkdownProps` | Override representation of any HTML tag or custom component. | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | ## ComponentsContainer **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/BlockContainer/components/ComponentsContainer.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/BlockContainer/components/ComponentsContainer.tsx#L17)_ **properties** | Name | Type | Parent | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------- | | `components*` |
`Components`
\[`string`]:
`interface`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| `ComponentsContainerProps` | | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | ## StoryBlockContainer **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/BlockContainer/story/StoryBlockContainer.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/BlockContainer/story/StoryBlockContainer.tsx#L20)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `story` |
`Story`<>
`name`\*: `string`
`storyName`: `string`
`id`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: **function** (
`controlValues`
\[`string`]: `any`
`context`: `any`
) => `Promise` \| `any`
`description`: `string`
`arguments`: `StoryArgument`\[]
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`source`: `string`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`
\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<`P`> \| `ComponentControlButton` \| `ComponentControlOptions` \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`
`smartControls`
`smart`: `boolean`
`include`: `string`\[] \| `IncludeFn`
`exclude`: `string`\[] \| `IncludeFn`
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
| `StoryBlockContainerAllProps` | Story interface - usually extracted by the AST instrumenting loader | | `useStoryDescription` | `boolean` | `StoryBlockContainerAllProps` | | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | ## DocumentItem **`react component`** displays a single doument item _defined in [@component-controls/blocks/ui/blocks/src/DocumentItem/DocumentItem.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/DocumentItem/DocumentItem.tsx#L27)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `item*` |
`DocInfo`
`title`\*: `string`
`image`: `string`
`description`: `string` \| `JSX.Element`
`date`: `string`
`tags`: `string`\[]
`author`: `string`
`type`: `"story"` \| `"blog"` \| `"page"` \| `"tags"` \| `"author"` \| `string`
`link`\*: `string`
`authorLink`: `string`
`rawTags`: `string`\[]
`rawType`: `string`
| `DocumentItemProps` | document to be displayed | | `showImage` | `boolean` | `DocumentItemProps` | if true, will also display the doc image | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | ## makeDecorators **`react function`** _defined in [@component-controls/blocks/ui/blocks/src/test/MockContext.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/test/MockContext.tsx#L24)_ **parameters** | Name | Type | Default | | ---------- | ----------------------------------------- | --------------- | | `storyId*` | `string` | `"id-of-story"` | | `props` | `Omit`<`MockContexProps`, `"storyId"`> | | | `returns` | returns | | ## StoryData **`react component`** Displays document data associated with a story _defined in [@component-controls/blocks/ui/blocks/src/StoryData/StoryData.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/StoryData/StoryData.tsx#L24)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `name` | `string` | `StoryInputProps` | | | `pagination` | | `BaseStoryDataProps` | | ## ComponentSource **`react component`** Displays import statement for a component as well as the component file source code Optionally also displays some repository information from the component's package.json _defined in [@component-controls/blocks/ui/blocks/src/ComponentSource/ComponentSource.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentSource/ComponentSource.tsx#L21)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `visibility` | `"controls"` \| `"info"` \| `"all"` | `ComponentsBlockContainerProps` | component level visibility | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `dark` | `boolean` | `SyntaxHighlighterProps` | used to specify a "dark" color theme - applcable only if no custom theme prop is provided. if dark: true, duotoneDark theme is used. if dark: false, duotoneLight theme is used. | | `theme` |
`PrismTheme`
`plain`\*
\[`string`]: `string` \| `number` \| `void`
`color`: `string`
`backgroundColor`: `string`
`fontStyle`: `"normal"` \| `"italic"`
`fontWeight`: `"normal"` \| `"bold"` \| `"100"` \| `"200"` \| `"300"` \| `"400"` \| `"500"` \| `"600"` \| `"700"` \| `"800"` \| `"900"`
`textDecorationLine`: `"none"` \| `"underline"` \| `"line-through"` \| `"underline line-through"`
`opacity`: `number`
`styles`\*: `type`\[]
| `SyntaxHighlighterProps` | optional `PrismTheme` theme provided to the component. Themes can be imported from `prism-react-renderer/themes` . | | `actions` | `ActionItem`\[] | `ActionContainerProps` | optional actions provided to the component | | `language` | `"markup"` \| `"bash"` \| `"clike"` \| `"c"` \| `"cpp"` \| `"css"` \| `"javascript"` \| `"jsx"` \| `"coffeescript"` \| `"actionscript"` \| `"css-extr"` \| `"diff"` \| `"git"` \| `"go"` \| `"graphql"` \| `"handlebars"` \| `"json"` \| `"less"` \| `"makefile"` \| `"markdown"` \| `"objectivec"` \| `"ocaml"` \| `"python"` \| `"reason"` \| `"sass"` \| `"scss"` \| `"sql"` \| `"stylus"` \| `"tsx"` \| `"typescript"` \| `"wasm"` \| `"yaml"` | `SyntaxHighlighterProps` | source lnguage used, by default "jsx". | | `renderFn` | **function** (
`props`\*
`tokens`\*: (`Token`\[])\[]
`className`\*: `string`
`style`\*
\[`string`]: `string` \| `number` \| `null`
`getLineProps`\*: **function** (
`input`\*
\[`string`]: `any`
`key`: React.Key
`style`: StyleObj
`className`: `string`
`line`\*: `Token`\[]
) =>
`LineOutputProps`
\[`string`]: `any`
`key`: React.Key
`style`: StyleObj
`className`\*: `string`

`getTokenProps`\*: **function** (
`input`\*
\[`string`]: `any`
`key`: React.Key
`style`: StyleObj
`className`: `string`
`token`\*
`types`\*:
`content`\*:
`empty`\*:
) =>
`TokenOutputProps`
\[`string`]: `any`
`key`: React.Key
`style`: StyleObj
`className`\*: `string`
`children`\*: `string`
`other`\*
`theme`\*
`plain`\*:
`styles`\*:
) => `ReturnType`<> | `SyntaxHighlighterProps` | custom function to render the source code. | | `metastring` | `string` | `SyntaxHighlighterProps` | code configuration string passed from MDX | ## ComponentCommits **`react component`** Displays commit history for a component _defined in [@component-controls/blocks/ui/blocks/src/ComponentCommits/ComponentCommits.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentCommits/ComponentCommits.tsx#L23)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `name` | `string` | `StoryInputProps` | | | `pagination` | | `BaseComponentCommitsProps` | | ## BaseTestsCoverage **`react component`** Displays jest tests coverage for a component _defined in [@component-controls/blocks/ui/blocks/src/TestsCoverage/BaseTestsCoverage.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/TestsCoverage/BaseTestsCoverage.tsx#L29)_ **properties** | Name | Type | Parent | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ---------------------------------------------- | | `component` |
`Component`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| `BaseTestsCoverageProps` | component specified for stories or story files | | `pagination` | | `BaseTestsCoverageProps` | | ## TestsCoverage **`react component`** Displays jest tests coverage for a component, within a block _defined in [@component-controls/blocks/ui/blocks/src/TestsCoverage/TestsCoverage.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/TestsCoverage/TestsCoverage.tsx#L20)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `name` | `string` | `StoryInputProps` | | | `pagination` | | `BaseTestsCoverageProps` | | ## TestsResults **`react component`** Displays tests results details for a component, within a block _defined in [@component-controls/blocks/ui/blocks/src/TestsResults/TestsResults.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/TestsResults/TestsResults.tsx#L20)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `name` | `string` | `StoryInputProps` | | | `pagination` | | `BaseTestsResultsProps` | | ## PackageLink **`react component`** displays a package npm link and version _defined in [@component-controls/blocks/ui/blocks/src/PackageLink/PackageLink.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PackageLink/PackageLink.tsx#L29)_ **properties** | Name | Type | Parent | Description | | ----------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | --------------------------------------------------------------------------- | | `name*` | `string` | `PackageLinkProps` | package name | | `version` | `string` | `PackageLinkProps` | optional version - if not provided will be lookup into dependencies | | `dependencies` |
`PackageDependencies`
\[`string`]: `PackageDependency`
| `PackageLinkProps` | list of dependencies - package name as the key and the version as the value | | `devDependencies` |
`PackageDependencies`
\[`string`]: `PackageDependency`
| `PackageLinkProps` | list of dependencies - package name as the key and the version as the value | ## Stories **`react component`** displays multiple stories in ther own Playground components _defined in [@component-controls/blocks/ui/blocks/src/Stories/Stories.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Stories/Stories.tsx#L26)_ **properties** | Name | Type | Parent | Default | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dark` | `boolean` | `StoriesOwnProps` | | whether to display the dark theme storysource code component | | `id` | `string` | `StoryInputProps` | | | | `name` | `string` | `StoryInputProps` | | | | `storyProps` | `any` | `StoryPlaygroundProps` | | | | `scale` | `number` | `PlaygroundOwnProps` | | default scale for the zoom feature. If scale is set to 0, the zoom feature will be disabled. | | `source` | `string` | `PlaygroundOwnProps` | | playground source option - valid when a Story is not embedded inside the Playground. | | `title` | `string` | `BlockContainerOwnProps` | `"Stories"` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | | optional markdown description. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | | `inlist` | `any` | `HTMLAttributes` | | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | | `variant` | `string` | `BoxOwnProps` | | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `openTab` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `PanelContainerOwnProps` | | by default, which tab to have open. | | `visibleTabs` | `boolean` | `PanelContainerOwnProps` | | if true, the tabs on the panels will be visible | | `background` | `"dark"` \| `"light"` | `PanelContainerOwnProps` | | background pattern type | | `direction` | `"ltr"` \| `"rtl"` | `PanelContainerOwnProps` | | direction type | | `actions` | `ActionItem`\[] | `ActionContainerProps` | | optional actions provided to the component | ## StoryConfig **`react component`** Displays the configuration object of a story. _defined in [@component-controls/blocks/ui/blocks/src/StoryConfig/StoryConfig.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/StoryConfig/StoryConfig.tsx#L26)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `sourceProps` |
`SourceProps`
`actions`: `ActionItem`\[]
`plain`: `boolean`
`children`: `string`
`theme`
`plain`\*
\[`string`]: `string` \| `number` \| `void`
`color`\*:
`backgroundColor`\*:
`fontStyle`\*:
`fontWeight`\*:
`textDecorationLine`\*:
`opacity`\*:
`styles`\*: `type`\[]
`title`: `string`
`language`: `"markup"` \| `"bash"` \| `"clike"` \| `"c"` \| `"cpp"` \| `"css"` \| `"javascript"` \| `"jsx"` \| `"coffeescript"` \| `"actionscript"` \| `"css-extr"` \| `"diff"` \| `"git"` \| `"go"` \| `"graphql"` \| `"handlebars"` \| `"json"` \| `"less"` \| `"makefile"` \| `"markdown"` \| `"objectivec"` \| `"ocaml"` \| `"python"` \| `"reason"` \| `"sass"` \| `"scss"` \| `"sql"` \| `"stylus"` \| `"tsx"` \| `"typescript"` \| `"wasm"` \| `"yaml"`
`renderFn`: **function** (
`props`\*
`tokens`\*: (`Token`\[])\[]
`className`\*: `string`
`style`\*
\[`string`]: `string` \| `number` \| `null`
`getLineProps`\*: **function** (
`input`\*:
) => LineOutputProps
`getTokenProps`\*: **function** (
`input`\*:
) => TokenOutputProps
`other`\*
`theme`\*
`plain`\*:
`styles`\*:
) => `ReturnType`<>
`dark`: `boolean`
`style`: CSSProperties
`as`: ElementType
`metastring`: `string`
| `StoryConfigProps` | | | `name` | `string` | `StoryInputProps` | | ## Container **`react component`** page inner container. will display a like to edit the page and a last updated date. _defined in [@component-controls/blocks/ui/blocks/src/Container/Container.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Container/Container.tsx#L22)_ **properties** | Name | Type | Parent | | ----------- | -------------------------------------------------------------------------------------- | ---------------- | | `author` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `ContainerProps` | | `secondRow` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `ContainerProps` | ## BaseComponentCommits **`react component`** Displays commit history for a component _defined in [@component-controls/blocks/ui/blocks/src/ComponentCommits/BaseComponentCommits.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/ComponentCommits/BaseComponentCommits.tsx#L24)_ **properties** | Name | Type | Parent | Default | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------- | ---------------------------------------------- | | `component` |
`Component`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| `BaseComponentCommitsProps` | | component specified for stories or story files | | `pagination` | `boolean` | `BaseComponentCommitsProps` | `true` | | ## TagsList **`react component`** displays a row of tags assigned to the current document, with links to their pages _defined in [@component-controls/blocks/ui/blocks/src/TagsList/TagsList.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/TagsList/TagsList.tsx#L33)_ **properties** | Name | Type | Parent | Default | Description | | ------------------- | ----------- | --------------- | ------- | --------------------------------------------------------- | | `tags` | `string`\[] | `TagsListProps` | | string list of tag names | | `raw` | `string`\[] | `TagsListProps` | | raw string values, useful for highlighting search results | | `limit` | `number` | `TagsListProps` | `0` | limit the number of tags to display | | `variant` | `string` | `TagProps` | | theme variant additional | | `transparentAmount` | `number` | `TagProps` | | transparent amount - 0 to 1 | | `borderSize` | `number` | `TagProps` | | borderSize in pixels | ## BaseStoryData **`react component`** Displays data-drven table of data rows _defined in [@component-controls/blocks/ui/blocks/src/StoryData/BaseStoryData.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/StoryData/BaseStoryData.tsx#L31)_ **properties** | Name | Type | Parent | Default | | ------------ | ------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------- | | `storyId*` | `string` | `BaseStoryDataProps` | | | `values` |
`ExampleControls`
\[`string`]: `ComponentControl` \| `any`
| `BaseStoryDataProps` | | | `pagination` | `boolean` | `BaseStoryDataProps` | `true` | ## BaseTestsResults **`react component`** Displays tests results details for a component _defined in [@component-controls/blocks/ui/blocks/src/TestsResults/BaseTestsResults.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/TestsResults/BaseTestsResults.tsx#L30)_ **properties** | Name | Type | Parent | Default | Description | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------- | ---------------------------------------------- | | `component` |
`Component`
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
| `BaseTestsResultsProps` | | component specified for stories or story files | | `pagination` | `boolean` | `BaseTestsResultsProps` | `true` | | ## StorySource **`react component`** Display source code of a story. If controls are used, all story arguments will be highlighted. Additional commands are made available if the repository data of the story is available. _defined in [@component-controls/blocks/ui/blocks/src/StorySource/StorySource.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/StorySource/StorySource.tsx#L36)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `viewStyle` | `"tags"` \| `"values"` | `StorySourceOwnProps` | initial view mode | | `sourceProps` |
`SourceProps`
`actions`: `ActionItem`\[]
`plain`: `boolean`
`children`: `string`
`theme`
`plain`\*
\[`string`]: `string` \| `number` \| `void`
`color`\*:
`backgroundColor`\*:
`fontStyle`\*:
`fontWeight`\*:
`textDecorationLine`\*:
`opacity`\*:
`styles`\*: `type`\[]
`title`: `string`
`language`: `"markup"` \| `"bash"` \| `"clike"` \| `"c"` \| `"cpp"` \| `"css"` \| `"javascript"` \| `"jsx"` \| `"coffeescript"` \| `"actionscript"` \| `"css-extr"` \| `"diff"` \| `"git"` \| `"go"` \| `"graphql"` \| `"handlebars"` \| `"json"` \| `"less"` \| `"makefile"` \| `"markdown"` \| `"objectivec"` \| `"ocaml"` \| `"python"` \| `"reason"` \| `"sass"` \| `"scss"` \| `"sql"` \| `"stylus"` \| `"tsx"` \| `"typescript"` \| `"wasm"` \| `"yaml"`
`renderFn`: **function** (
`props`\*
`tokens`\*: (`Token`\[])\[]
`className`\*: `string`
`style`\*
\[`string`]: `string` \| `number` \| `null`
`getLineProps`\*: **function** (
`input`\*:
) => LineOutputProps
`getTokenProps`\*: **function** (
`input`\*:
) => TokenOutputProps
`other`\*
`theme`\*
`plain`\*:
`styles`\*:
) => `ReturnType`<>
`dark`: `boolean`
`style`: CSSProperties
`as`: ElementType
`metastring`: `string`
| `StorySourceOwnProps` | source code options | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `name` | `string` | `StoryInputProps` | | ## PropsTable **`react component`** Displays the component's properties as well as configurable controls to interact with the component. _defined in [@component-controls/blocks/ui/blocks/src/PropsTable/PropsTable.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/PropsTable/PropsTable.tsx#L35)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `extraColumns` | `Column`\[] | `PropsTableOwnProps` | extra custom columns passed to the PropsTable. | | `flat` | `boolean` | `PropsTableOwnProps` | if true, will flatten the group by | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `visibility` | `"controls"` \| `"info"` \| `"all"` | `ComponentsBlockContainerProps` | component level visibility | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | ## getUrlParams **`react function`** _defined in [@component-controls/blocks/ui/blocks/src/utils/url.ts](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/url.ts#L35)_ **parameters** | Name | Type | | ------------ | -------- | | `paremName*` | `string` | | `returns` | `any` | ## ComponentsBlockContainer **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/BlockContainer/components/ComponentsBlockContainer.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/BlockContainer/components/ComponentsBlockContainer.tsx#L45)_ **properties** | Name | Type | Parent | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `visibility` | `"controls"` \| `"info"` \| `"all"` | `ComponentsBlockContainerProps` | component level visibility | | `onSelect` | **function** (
`name`\*: `string`
`component`\*
`name`\*: `string`
`importedName`: `"default"` \| `"namespace"` \| `string`
`from`: `string`
`request`: `string`
`fileName`: `string`
`propsInfoFile`: `string`
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`package`: `string`
`source`: `string`
`info`
`displayName`\*: `string`
`description`: `string`
`props`\*
\[`string`]: PropType
`externalDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`localDependencies`
\[`string`]: (`Omit`<`ImportType`, `"from"`>)\[]
`jsx`: `JSXNode`\[]
`fileInfo`
`dateCreated`: `string`
`dateModified`: `string`
`commits`: Commits
`sloc`
`block`\*:
`blockEmpty`\*:
`comment`\*:
`empty`\*:
`mixed`\*:
`single`\*:
`source`\*:
`todo`\*:
`total`\*:
`jest`
`results`\*: `JestResult`\[]
`coverage`\*: `Record`<`string`, `JestCoverage`>
) => `boolean` \| `void` | `ComponentsContainerProps` | callback to be called when the tab changes if the function returns false, it can stop chabging to the new tab | | `of` | `any` | `ComponentInputProps` | Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the current component (associated with the current Story). If an array of components is specified, each component will be displayed in a separate tab. | | `name` | `string` | `ComponentInputProps` | some component-oriented ui components can also be driven by a story id (name). ie the PropsTable can display component props, or story controls | | `title` | `string` | `BlockContainerOwnProps` | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | `inlist` | `any` | `HTMLAttributes` | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | `variant` | `string` | `BoxOwnProps` | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | ## BasePlayground **`react component`** _defined in [@component-controls/blocks/ui/blocks/src/Playground/BasePlayground.tsx](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/Playground/BasePlayground.tsx#L49)_ **properties** | Name | Type | Parent | Default | Description | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `scale` | `number` | `PlaygroundOwnProps` | | default scale for the zoom feature. If scale is set to 0, the zoom feature will be disabled. | | `source` | `string` | `PlaygroundOwnProps` | | playground source option - valid when a Story is not embedded inside the Playground. | | `dark` | `boolean` | `PlaygroundOwnProps` | | whether to use the dark theme for the story source component. | | `title` | `string` | `BlockContainerOwnProps` | | optional section title for the block. | | `description` | `string` | `BlockContainerOwnProps` | | optional markdown description. | | `id` | `string` | `BlockContainerOwnProps` | | optional id to be used for the block if no id is provided, one will be calculated automatically from the title. | | `collapsible` | `boolean` | `BlockContainerOwnProps` | | if false, will nothave a collapsible frame. | | `data-testid` | `string` | `BlockContainerOwnProps` | | testing id | | `plain` | `boolean` | `BlockContainerOwnProps` | | inner container variant or plain | | `slot` | `string` \| `undefined` | `HTMLAttributes` | | | | `style` | `CSSProperties` \| `undefined` | `HTMLAttributes` | | | | `key` | `Key` \| `null` \| `undefined` | `Attributes` | | | | `sx` | `ThemeUICSSObject` \| `ThemeDerivedStyles` | `Attributes` | | The `ThemeUIStyleObject` extends \[style props](https://emotion.sh/docs/object-styles) such that properties that are part of the `Theme` will be transformed to their corresponding values. Other valid CSS properties are also allowed. | | `defaultChecked` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `defaultValue` | `string` \| `number` \| `ReadonlyArray`<`string`> \| `undefined` | `HTMLAttributes` | | | | `suppressContentEditableWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `suppressHydrationWarning` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `accessKey` | `string` \| `undefined` | `HTMLAttributes` | | | | `className` | `string` \| `undefined` | `HTMLAttributes` | | | | `contentEditable` | `Booleanish` \| `"inherit"` \| `undefined` | `HTMLAttributes` | | | | `contextMenu` | `string` \| `undefined` | `HTMLAttributes` | | | | `dir` | `string` \| `undefined` | `HTMLAttributes` | | | | `draggable` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | | `hidden` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `lang` | `string` \| `undefined` | `HTMLAttributes` | | | | `placeholder` | `string` \| `undefined` | `HTMLAttributes` | | | | `spellCheck` | `Booleanish` \| `undefined` | `HTMLAttributes` | | | | `tabIndex` | `number` \| `undefined` | `HTMLAttributes` | | | | `translate` | `"yes"` \| `"no"` \| `undefined` | `HTMLAttributes` | | | | `radioGroup` | `string` \| `undefined` | `HTMLAttributes` | | | | `role` | `AriaRole` \| `undefined` | `HTMLAttributes` | | | | `about` | `string` \| `undefined` | `HTMLAttributes` | | | | `datatype` | `string` \| `undefined` | `HTMLAttributes` | | | | `inlist` | `any` | `HTMLAttributes` | | | | `prefix` | `string` \| `undefined` | `HTMLAttributes` | | | | `property` | `string` \| `undefined` | `HTMLAttributes` | | | | `resource` | `string` \| `undefined` | `HTMLAttributes` | | | | `typeof` | `string` \| `undefined` | `HTMLAttributes` | | | | `vocab` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoCapitalize` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoCorrect` | `string` \| `undefined` | `HTMLAttributes` | | | | `autoSave` | `string` \| `undefined` | `HTMLAttributes` | | | | `color` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemProp` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemScope` | `boolean` \| `undefined` | `HTMLAttributes` | | | | `itemType` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemID` | `string` \| `undefined` | `HTMLAttributes` | | | | `itemRef` | `string` \| `undefined` | `HTMLAttributes` | | | | `results` | `number` \| `undefined` | `HTMLAttributes` | | | | `security` | `string` \| `undefined` | `HTMLAttributes` | | | | `unselectable` | `"on"` \| `"off"` \| `undefined` | `HTMLAttributes` | | | | `inputMode` | `"none"` \| `"text"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"` \| `"search"` \| `undefined` | `HTMLAttributes` | | Hints at the type of data that might be entered by the user while editing the element or its contents | | `is` | `string` \| `undefined` | `HTMLAttributes` | | Specify that a standard HTML element should behave like a defined custom built-in element | | `aria-activedescendant` | `string` \| `undefined` | `AriaAttributes` | | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | | `aria-atomic` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | | `aria-autocomplete` | `"none"` \| `"inline"` \| `"list"` \| `"both"` \| `undefined` | `AriaAttributes` | | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | | `aria-busy` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | | `aria-checked` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | | `aria-colcount` | `number` \| `undefined` | `AriaAttributes` | | Defines the total number of columns in a table, grid, or treegrid. | | `aria-colindex` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | | `aria-colspan` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-controls` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) whose contents or presence are controlled by the current element. | | `aria-current` | `boolean` \| `"false"` \| `"true"` \| `"page"` \| `"step"` \| `"location"` \| `"date"` \| `"time"` \| `undefined` | `AriaAttributes` | | Indicates the element that represents the current item within a container or set of related elements. | | `aria-describedby` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) that describes the object. | | `aria-details` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element that provides a detailed, extended description for the object. | | `aria-disabled` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | | `aria-dropeffect` | `"none"` \| `"copy"` \| `"execute"` \| `"link"` \| `"move"` \| `"popup"` \| `undefined` | `AriaAttributes` | | Indicates what functions can be performed when a dragged object is released on the drop target. | | `aria-errormessage` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element that provides an error message for the object. | | `aria-expanded` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | | `aria-flowto` | `string` \| `undefined` | `AriaAttributes` | | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | | `aria-grabbed` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates an element's "grabbed" state in a drag-and-drop operation. | | `aria-haspopup` | `boolean` \| `"false"` \| `"true"` \| `"menu"` \| `"listbox"` \| `"tree"` \| `"grid"` \| `"dialog"` \| `undefined` | `AriaAttributes` | | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | | `aria-hidden` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether the element is exposed to an accessibility API. | | `aria-invalid` | `boolean` \| `"false"` \| `"true"` \| `"grammar"` \| `"spelling"` \| `undefined` | `AriaAttributes` | | Indicates the entered value does not conform to the format expected by the application. | | `aria-keyshortcuts` | `string` \| `undefined` | `AriaAttributes` | | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | | `aria-label` | `string` \| `undefined` | `AriaAttributes` | | Defines a string value that labels the current element. | | `aria-labelledby` | `string` \| `undefined` | `AriaAttributes` | | Identifies the element (or elements) that labels the current element. | | `aria-level` | `number` \| `undefined` | `AriaAttributes` | | Defines the hierarchical level of an element within a structure. | | `aria-live` | `"off"` \| `"assertive"` \| `"polite"` \| `undefined` | `AriaAttributes` | | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | | `aria-modal` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether an element is modal when displayed. | | `aria-multiline` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates whether a text box accepts multiple lines of input or only a single line. | | `aria-multiselectable` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the user may select more than one item from the current selectable descendants. | | `aria-orientation` | `"horizontal"` \| `"vertical"` \| `undefined` | `AriaAttributes` | | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | | `aria-owns` | `string` \| `undefined` | `AriaAttributes` | | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | | `aria-placeholder` | `string` \| `undefined` | `AriaAttributes` | | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | | `aria-posinset` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-pressed` | `boolean` \| `"false"` \| `"mixed"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "pressed" state of toggle buttons. | | `aria-readonly` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that the element is not editable, but is otherwise operable. | | `aria-relevant` | `"additions"` \| `"additions removals"` \| `"additions text"` \| `"all"` \| `"removals"` \| `"removals additions"` \| `"removals text"` \| `"text"` \| `"text additions"` \| `"text removals"` \| `undefined` | `AriaAttributes` | | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | | `aria-required` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates that user input is required on the element before a form may be submitted. | | `aria-roledescription` | `string` \| `undefined` | `AriaAttributes` | | Defines a human-readable, author-localized description for the role of an element. | | `aria-rowcount` | `number` \| `undefined` | `AriaAttributes` | | Defines the total number of rows in a table, grid, or treegrid. | | `aria-rowindex` | `number` \| `undefined` | `AriaAttributes` | | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | | `aria-rowspan` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | | `aria-selected` | `boolean` \| `"false"` \| `"true"` \| `undefined` | `AriaAttributes` | | Indicates the current "selected" state of various widgets. | | `aria-setsize` | `number` \| `undefined` | `AriaAttributes` | | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | | `aria-sort` | `"none"` \| `"ascending"` \| `"descending"` \| `"other"` \| `undefined` | `AriaAttributes` | | Indicates if items in a table or grid are sorted in ascending or descending order. | | `aria-valuemax` | `number` \| `undefined` | `AriaAttributes` | | Defines the maximum allowed value for a range widget. | | `aria-valuemin` | `number` \| `undefined` | `AriaAttributes` | | Defines the minimum allowed value for a range widget. | | `aria-valuenow` | `number` \| `undefined` | `AriaAttributes` | | Defines the current value for a range widget. | | `aria-valuetext` | `string` \| `undefined` | `AriaAttributes` | | Defines the human readable text alternative of aria-valuenow for a range widget. | | `dangerouslySetInnerHTML` | `type` \| `undefined` | `DOMAttributes` | | | | `onCopy` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCopyCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCut` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCutCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPaste` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPasteCapture` | `ClipboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionEnd` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionEndCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionStart` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionStartCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionUpdate` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCompositionUpdateCapture` | `CompositionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onFocus` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onFocusCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBlur` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBlurCapture` | `FocusEventHandler` \| `undefined` | `DOMAttributes` | | | | `onChange` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onChangeCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBeforeInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onBeforeInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInput` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInputCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onReset` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onResetCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSubmit` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSubmitCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInvalid` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onInvalidCapture` | `FormEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoad` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onError` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onErrorCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyDown` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyDownCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyPress` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyPressCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyUp` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onKeyUpCapture` | `KeyboardEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAbort` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAbortCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayThrough` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onCanPlayThroughCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDurationChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDurationChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEmptied` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEmptiedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEncrypted` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEncryptedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEnded` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onEndedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedData` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedDataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedMetadata` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadedMetadataCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadStart` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLoadStartCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPause` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPauseCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlay` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlayCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlaying` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPlayingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onProgress` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onProgressCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onRateChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onRateChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeeked` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeekedCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeeking` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSeekingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onStalled` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onStalledCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSuspend` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSuspendCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTimeUpdate` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTimeUpdateCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onVolumeChange` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onVolumeChangeCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWaiting` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWaitingCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAuxClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAuxClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onContextMenu` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onContextMenuCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDoubleClick` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDoubleClickCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDrag` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnd` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEndCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnter` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragEnterCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragExit` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragExitCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragLeave` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragLeaveCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragOver` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragOverCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragStart` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDragStartCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDrop` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onDropCapture` | `DragEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseDown` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseDownCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseEnter` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseLeave` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseMove` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseMoveCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOut` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOutCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOver` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseOverCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseUp` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onMouseUpCapture` | `MouseEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSelect` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onSelectCapture` | `ReactEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchCancel` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchCancelCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchEnd` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchEndCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchMove` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchMoveCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchStart` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTouchStartCapture` | `TouchEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerDown` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerDownCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerMove` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerMoveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerUp` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerUpCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerCancel` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerCancelCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerEnter` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerEnterCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerLeave` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerLeaveCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOver` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOverCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOut` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onPointerOutCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onGotPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onGotPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLostPointerCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onLostPointerCaptureCapture` | `PointerEventHandler` \| `undefined` | `DOMAttributes` | | | | `onScroll` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | | `onScrollCapture` | `UIEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWheel` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | | `onWheelCapture` | `WheelEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationStart` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationStartCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationEnd` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationEndCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationIteration` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onAnimationIterationCapture` | `AnimationEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTransitionEnd` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | | `onTransitionEndCapture` | `TransitionEventHandler` \| `undefined` | `DOMAttributes` | | | | `ref` | `Exclude`<`R`, `string`> \| `undefined` | `PropsWithRef` | | | | `as` |
`React.ElementType`
`at`\*: **function** (
`index`\*: `number`
) => `T` \| `undefined`
| `BoxOwnProps` | | | | `variant` | `string` | `BoxOwnProps` | | | | `css` | `InterpolationPrimitive` \| `ArrayInterpolation`<> \| `FunctionInterpolation`<> | `BoxOwnProps` | | | | `m` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top, left, bottom and right | | `margin` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top, left, bottom and right | | `mt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top | | `marginTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top | | `mr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on right | | `marginRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on right | | `mb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on bottom | | `marginBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on bottom | | `ml` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left | | `marginLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left | | `mx` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left and right | | `marginX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on left and right | | `my` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top and bottom | | `marginY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Margin on top and bottom | | `p` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top, left, bottom and right | | `padding` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top, left, bottom and right | | `pt` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top | | `paddingTop` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top | | `pr` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on right | | `paddingRight` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on right | | `pb` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on bottom | | `paddingBottom` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on bottom | | `pl` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left | | `paddingLeft` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left | | `px` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left and right | | `paddingX` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on left and right | | `py` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top and bottom | | `paddingY` | `ResponsiveValue` \| `undefined` | `SpaceProps` | | Padding on top and bottom | | `bg` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | The color utility parses a component's `color` and `bg` props and converts them into CSS declarations. By default the raw value of the prop is returned. Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values. \[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) | | `backgroundColor` | `ResponsiveValue` \| `undefined` | `BackgroundColorProps` | | | | `opacity` | `ResponsiveValue` \| `undefined` | `OpacityProps` | | The opacity CSS property sets the transparency of an element or the degree to which content behind an element is visible. \[MDN reference](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) | | `openTab` | `ReactChild` \| `ReactFragment` \| `ReactPortal` \| `boolean` \| `null` \| `undefined` | `PanelContainerOwnProps` | | by default, which tab to have open. | | `visibleTabs` | `boolean` | `PanelContainerOwnProps` | | if true, the tabs on the panels will be visible | | `background` | `"dark"` \| `"light"` | `PanelContainerOwnProps` | | background pattern type | | `direction` | `"ltr"` \| `"rtl"` | `PanelContainerOwnProps` | | direction type | | `actions` | `ActionItem`\[] | `ActionContainerProps` | | optional actions provided to the component | | `story` |
`Story`<>
`name`\*: `string`
`storyName`: `string`
`id`: `string`
`rawId`: `string`
`doc`: `string`
`storyFn`: **function** (
`controlValues`
\[`string`]: `any`
`context`: `any`
) => `Promise` \| `any`
`description`: `string`
`arguments`: `StoryArgument`\[]
`loc`
`start`\*
`line`\*:
`column`\*:
`end`\*
`line`\*:
`column`\*:
`source`: `string`
`subtitle`: `string`
`dynamic`: `boolean`
`dynamicId`: `string`
`component`
`at`\*:
`subcomponents`: `Record`<`string`, (`string`, `Record`<`string`, `unknown`>, `ElementType`<`Props`>)>
`controls`
\[`string`]: `ComponentControlText` \| `ComponentControlBoolean` \| `ComponentControlColor` \| `ComponentControlDate` \| `ComponentControlObject`<`P`> \| `ComponentControlButton` \| `ComponentControlOptions` \| `ComponentControlNumber` \| `ComponentControlArray` \| `ComponentControlFiles`
`smartControls`
`smart`: `boolean`
`include`: `string`\[] \| `IncludeFn`
`exclude`: `string`\[] \| `IncludeFn`
`decorators`: `StoryRenderFn`\[]
`plugins`: `any`
`category`: `string`
| `BasePlaygroundProps` | | Story interface - usually extracted by the AST instrumenting loader | | `isDark` | `boolean` | `BasePlaygroundProps` | | | | `wrapper` | `boolean` | `BasePlaygroundProps` | `true` | | ## useURLParams **`react function`** _defined in [@component-controls/blocks/ui/blocks/src/utils/url.ts](https://github.com/ccontrols/component-controls/tree/master/ui/blocks/src/utils/url.ts#L51)_ **parameters** | Name | Type | | --------------- | ------------------ | | `name*` | `string` | | `initialState*` | `S` | | `returns` | \[`S`, `function`] |