Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@component-controls/app

Package Overview
Dependencies
Maintainers
1
Versions
213
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@component-controls/app

Component controls standalone application.

  • 4.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
137
decreased by-39.65%
Maintainers
1
Weekly downloads
 
Created
Source

Table of contents

Overview

Components to create @component-controls standalone application, that is connected to the store of documents.

Some of the design goals:

  • Portability between different build systems ie - Gatsby, CRA, Vercel.
  • Create a true CMS-type user-interface, allowing for different document types ie. "stories", "blogs", "articles".
  • Category pages for "tags", "authors".
  • Fully customizable Home page.
  • Responsive user/interface, with sidebars transforming into popouts for small screen resolutions.

List of components

SidebarsPage

react component

defined in @component-controls/app/ui/app/src/SidebarsPage/SidebarsPage.tsx

properties

NameTypeParentDescription
type"story" | "blog" | "page" | "tags" | "author" | stringDocPagePropsdocument type

react component

application footer component

defined in @component-controls/app/ui/app/src/Footer/Footer.tsx

react component

native lonk to a story

defined in @component-controls/app/ui/app/src/Links/StoryLink.tsx

properties

NameTypeParentDescription
id*stringStoryLinkProps
typestring | undefinedAnchorHTMLAttributes
pResponsiveValue | undefinedSpacePropsPadding on top, left, bottom and right
slotstring | undefinedHTMLAttributes
styleCSSProperties | undefinedHTMLAttributes
titlestring | undefinedHTMLAttributes
refExclude<R, string> | undefinedPropsWithRef
keyKey | null | undefinedAttributes
sxThemeUICSSObject | ThemeDerivedStylesAttributesThe 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.
downloadanyAnchorHTMLAttributes
hrefLangstring | undefinedAnchorHTMLAttributes
mediastring | undefinedAnchorHTMLAttributes
pingstring | undefinedAnchorHTMLAttributes
relstring | undefinedAnchorHTMLAttributes
targetHTMLAttributeAnchorTarget | undefinedAnchorHTMLAttributes
referrerPolicyHTMLAttributeReferrerPolicy | undefinedAnchorHTMLAttributes
defaultCheckedboolean | undefinedHTMLAttributes
defaultValuestring | number | ReadonlyArray<string> | undefinedHTMLAttributes
suppressContentEditableWarningboolean | undefinedHTMLAttributes
suppressHydrationWarningboolean | undefinedHTMLAttributes
accessKeystring | undefinedHTMLAttributes
classNamestring | undefinedHTMLAttributes
contentEditableBooleanish | "inherit" | undefinedHTMLAttributes
contextMenustring | undefinedHTMLAttributes
dirstring | undefinedHTMLAttributes
draggableBooleanish | undefinedHTMLAttributes
hiddenboolean | undefinedHTMLAttributes
langstring | undefinedHTMLAttributes
placeholderstring | undefinedHTMLAttributes
spellCheckBooleanish | undefinedHTMLAttributes
tabIndexnumber | undefinedHTMLAttributes
translate"yes" | "no" | undefinedHTMLAttributes
radioGroupstring | undefinedHTMLAttributes
roleAriaRole | undefinedHTMLAttributes
aboutstring | undefinedHTMLAttributes
datatypestring | undefinedHTMLAttributes
inlistanyHTMLAttributes
prefixstring | undefinedHTMLAttributes
propertystring | undefinedHTMLAttributes
resourcestring | undefinedHTMLAttributes
typeofstring | undefinedHTMLAttributes
vocabstring | undefinedHTMLAttributes
autoCapitalizestring | undefinedHTMLAttributes
autoCorrectstring | undefinedHTMLAttributes
autoSavestring | undefinedHTMLAttributes
colorstring | undefinedHTMLAttributes
itemPropstring | undefinedHTMLAttributes
itemScopeboolean | undefinedHTMLAttributes
itemTypestring | undefinedHTMLAttributes
itemIDstring | undefinedHTMLAttributes
itemRefstring | undefinedHTMLAttributes
resultsnumber | undefinedHTMLAttributes
securitystring | undefinedHTMLAttributes
unselectable"on" | "off" | undefinedHTMLAttributes
inputMode"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefinedHTMLAttributesHints at the type of data that might be entered by the user while editing the element or its contents
isstring | undefinedHTMLAttributesSpecify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendantstring | undefinedAriaAttributesIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "false" | "true" | undefinedAriaAttributesIndicates 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" | undefinedAriaAttributesIndicates 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-busyboolean | "false" | "true" | undefinedAriaAttributesIndicates 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-checkedboolean | "false" | "mixed" | "true" | undefinedAriaAttributesIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber | undefinedAriaAttributesDefines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber | undefinedAriaAttributesDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colspannumber | undefinedAriaAttributesDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring | undefinedAriaAttributesIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefinedAriaAttributesIndicates the element that represents the current item within a container or set of related elements.
aria-describedbystring | undefinedAriaAttributesIdentifies the element (or elements) that describes the object.
aria-detailsstring | undefinedAriaAttributesIdentifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "false" | "true" | undefinedAriaAttributesIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"none" | "copy" | "execute" | "link" | "move" | "popup" | undefinedAriaAttributesIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring | undefinedAriaAttributesIdentifies the element that provides an error message for the object.
aria-expandedboolean | "false" | "true" | undefinedAriaAttributesIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring | undefinedAriaAttributesIdentifies 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-grabbedboolean | "false" | "true" | undefinedAriaAttributesIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefinedAriaAttributesIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "false" | "true" | undefinedAriaAttributesIndicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "false" | "true" | "grammar" | "spelling" | undefinedAriaAttributesIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring | undefinedAriaAttributesIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring | undefinedAriaAttributesDefines a string value that labels the current element.
aria-labelledbystring | undefinedAriaAttributesIdentifies the element (or elements) that labels the current element.
aria-levelnumber | undefinedAriaAttributesDefines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite" | undefinedAriaAttributesIndicates 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-modalboolean | "false" | "true" | undefinedAriaAttributesIndicates whether an element is modal when displayed.
aria-multilineboolean | "false" | "true" | undefinedAriaAttributesIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "false" | "true" | undefinedAriaAttributesIndicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical" | undefinedAriaAttributesIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring | undefinedAriaAttributesIdentifies 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-placeholderstring | undefinedAriaAttributesDefines 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-posinsetnumber | undefinedAriaAttributesDefines 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-pressedboolean | "false" | "mixed" | "true" | undefinedAriaAttributesIndicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "false" | "true" | undefinedAriaAttributesIndicates 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" | undefinedAriaAttributesIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "false" | "true" | undefinedAriaAttributesIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring | undefinedAriaAttributesDefines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber | undefinedAriaAttributesDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber | undefinedAriaAttributesDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowspannumber | undefinedAriaAttributesDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "false" | "true" | undefinedAriaAttributesIndicates the current "selected" state of various widgets.
aria-setsizenumber | undefinedAriaAttributesDefines 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" | undefinedAriaAttributesIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber | undefinedAriaAttributesDefines the maximum allowed value for a range widget.
aria-valueminnumber | undefinedAriaAttributesDefines the minimum allowed value for a range widget.
aria-valuenownumber | undefinedAriaAttributesDefines the current value for a range widget.
aria-valuetextstring | undefinedAriaAttributesDefines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTMLtype | undefinedDOMAttributes
onCopyClipboardEventHandler | undefinedDOMAttributes
onCopyCaptureClipboardEventHandler | undefinedDOMAttributes
onCutClipboardEventHandler | undefinedDOMAttributes
onCutCaptureClipboardEventHandler | undefinedDOMAttributes
onPasteClipboardEventHandler | undefinedDOMAttributes
onPasteCaptureClipboardEventHandler | undefinedDOMAttributes
onCompositionEndCompositionEventHandler | undefinedDOMAttributes
onCompositionEndCaptureCompositionEventHandler | undefinedDOMAttributes
onCompositionStartCompositionEventHandler | undefinedDOMAttributes
onCompositionStartCaptureCompositionEventHandler | undefinedDOMAttributes
onCompositionUpdateCompositionEventHandler | undefinedDOMAttributes
onCompositionUpdateCaptureCompositionEventHandler | undefinedDOMAttributes
onFocusFocusEventHandler | undefinedDOMAttributes
onFocusCaptureFocusEventHandler | undefinedDOMAttributes
onBlurFocusEventHandler | undefinedDOMAttributes
onBlurCaptureFocusEventHandler | undefinedDOMAttributes
onChangeFormEventHandler | undefinedDOMAttributes
onChangeCaptureFormEventHandler | undefinedDOMAttributes
onBeforeInputFormEventHandler | undefinedDOMAttributes
onBeforeInputCaptureFormEventHandler | undefinedDOMAttributes
onInputFormEventHandler | undefinedDOMAttributes
onInputCaptureFormEventHandler | undefinedDOMAttributes
onResetFormEventHandler | undefinedDOMAttributes
onResetCaptureFormEventHandler | undefinedDOMAttributes
onSubmitFormEventHandler | undefinedDOMAttributes
onSubmitCaptureFormEventHandler | undefinedDOMAttributes
onInvalidFormEventHandler | undefinedDOMAttributes
onInvalidCaptureFormEventHandler | undefinedDOMAttributes
onLoadReactEventHandler | undefinedDOMAttributes
onLoadCaptureReactEventHandler | undefinedDOMAttributes
onErrorReactEventHandler | undefinedDOMAttributes
onErrorCaptureReactEventHandler | undefinedDOMAttributes
onKeyDownKeyboardEventHandler | undefinedDOMAttributes
onKeyDownCaptureKeyboardEventHandler | undefinedDOMAttributes
onKeyPressKeyboardEventHandler | undefinedDOMAttributes
onKeyPressCaptureKeyboardEventHandler | undefinedDOMAttributes
onKeyUpKeyboardEventHandler | undefinedDOMAttributes
onKeyUpCaptureKeyboardEventHandler | undefinedDOMAttributes
onAbortReactEventHandler | undefinedDOMAttributes
onAbortCaptureReactEventHandler | undefinedDOMAttributes
onCanPlayReactEventHandler | undefinedDOMAttributes
onCanPlayCaptureReactEventHandler | undefinedDOMAttributes
onCanPlayThroughReactEventHandler | undefinedDOMAttributes
onCanPlayThroughCaptureReactEventHandler | undefinedDOMAttributes
onDurationChangeReactEventHandler | undefinedDOMAttributes
onDurationChangeCaptureReactEventHandler | undefinedDOMAttributes
onEmptiedReactEventHandler | undefinedDOMAttributes
onEmptiedCaptureReactEventHandler | undefinedDOMAttributes
onEncryptedReactEventHandler | undefinedDOMAttributes
onEncryptedCaptureReactEventHandler | undefinedDOMAttributes
onEndedReactEventHandler | undefinedDOMAttributes
onEndedCaptureReactEventHandler | undefinedDOMAttributes
onLoadedDataReactEventHandler | undefinedDOMAttributes
onLoadedDataCaptureReactEventHandler | undefinedDOMAttributes
onLoadedMetadataReactEventHandler | undefinedDOMAttributes
onLoadedMetadataCaptureReactEventHandler | undefinedDOMAttributes
onLoadStartReactEventHandler | undefinedDOMAttributes
onLoadStartCaptureReactEventHandler | undefinedDOMAttributes
onPauseReactEventHandler | undefinedDOMAttributes
onPauseCaptureReactEventHandler | undefinedDOMAttributes
onPlayReactEventHandler | undefinedDOMAttributes
onPlayCaptureReactEventHandler | undefinedDOMAttributes
onPlayingReactEventHandler | undefinedDOMAttributes
onPlayingCaptureReactEventHandler | undefinedDOMAttributes
onProgressReactEventHandler | undefinedDOMAttributes
onProgressCaptureReactEventHandler | undefinedDOMAttributes
onRateChangeReactEventHandler | undefinedDOMAttributes
onRateChangeCaptureReactEventHandler | undefinedDOMAttributes
onSeekedReactEventHandler | undefinedDOMAttributes
onSeekedCaptureReactEventHandler | undefinedDOMAttributes
onSeekingReactEventHandler | undefinedDOMAttributes
onSeekingCaptureReactEventHandler | undefinedDOMAttributes
onStalledReactEventHandler | undefinedDOMAttributes
onStalledCaptureReactEventHandler | undefinedDOMAttributes
onSuspendReactEventHandler | undefinedDOMAttributes
onSuspendCaptureReactEventHandler | undefinedDOMAttributes
onTimeUpdateReactEventHandler | undefinedDOMAttributes
onTimeUpdateCaptureReactEventHandler | undefinedDOMAttributes
onVolumeChangeReactEventHandler | undefinedDOMAttributes
onVolumeChangeCaptureReactEventHandler | undefinedDOMAttributes
onWaitingReactEventHandler | undefinedDOMAttributes
onWaitingCaptureReactEventHandler | undefinedDOMAttributes
onAuxClickMouseEventHandler | undefinedDOMAttributes
onAuxClickCaptureMouseEventHandler | undefinedDOMAttributes
onClickMouseEventHandler | undefinedDOMAttributes
onClickCaptureMouseEventHandler | undefinedDOMAttributes
onContextMenuMouseEventHandler | undefinedDOMAttributes
onContextMenuCaptureMouseEventHandler | undefinedDOMAttributes
onDoubleClickMouseEventHandler | undefinedDOMAttributes
onDoubleClickCaptureMouseEventHandler | undefinedDOMAttributes
onDragDragEventHandler | undefinedDOMAttributes
onDragCaptureDragEventHandler | undefinedDOMAttributes
onDragEndDragEventHandler | undefinedDOMAttributes
onDragEndCaptureDragEventHandler | undefinedDOMAttributes
onDragEnterDragEventHandler | undefinedDOMAttributes
onDragEnterCaptureDragEventHandler | undefinedDOMAttributes
onDragExitDragEventHandler | undefinedDOMAttributes
onDragExitCaptureDragEventHandler | undefinedDOMAttributes
onDragLeaveDragEventHandler | undefinedDOMAttributes
onDragLeaveCaptureDragEventHandler | undefinedDOMAttributes
onDragOverDragEventHandler | undefinedDOMAttributes
onDragOverCaptureDragEventHandler | undefinedDOMAttributes
onDragStartDragEventHandler | undefinedDOMAttributes
onDragStartCaptureDragEventHandler | undefinedDOMAttributes
onDropDragEventHandler | undefinedDOMAttributes
onDropCaptureDragEventHandler | undefinedDOMAttributes
onMouseDownMouseEventHandler | undefinedDOMAttributes
onMouseDownCaptureMouseEventHandler | undefinedDOMAttributes
onMouseEnterMouseEventHandler | undefinedDOMAttributes
onMouseLeaveMouseEventHandler | undefinedDOMAttributes
onMouseMoveMouseEventHandler | undefinedDOMAttributes
onMouseMoveCaptureMouseEventHandler | undefinedDOMAttributes
onMouseOutMouseEventHandler | undefinedDOMAttributes
onMouseOutCaptureMouseEventHandler | undefinedDOMAttributes
onMouseOverMouseEventHandler | undefinedDOMAttributes
onMouseOverCaptureMouseEventHandler | undefinedDOMAttributes
onMouseUpMouseEventHandler | undefinedDOMAttributes
onMouseUpCaptureMouseEventHandler | undefinedDOMAttributes
onSelectReactEventHandler | undefinedDOMAttributes
onSelectCaptureReactEventHandler | undefinedDOMAttributes
onTouchCancelTouchEventHandler | undefinedDOMAttributes
onTouchCancelCaptureTouchEventHandler | undefinedDOMAttributes
onTouchEndTouchEventHandler | undefinedDOMAttributes
onTouchEndCaptureTouchEventHandler | undefinedDOMAttributes
onTouchMoveTouchEventHandler | undefinedDOMAttributes
onTouchMoveCaptureTouchEventHandler | undefinedDOMAttributes
onTouchStartTouchEventHandler | undefinedDOMAttributes
onTouchStartCaptureTouchEventHandler | undefinedDOMAttributes
onPointerDownPointerEventHandler | undefinedDOMAttributes
onPointerDownCapturePointerEventHandler | undefinedDOMAttributes
onPointerMovePointerEventHandler | undefinedDOMAttributes
onPointerMoveCapturePointerEventHandler | undefinedDOMAttributes
onPointerUpPointerEventHandler | undefinedDOMAttributes
onPointerUpCapturePointerEventHandler | undefinedDOMAttributes
onPointerCancelPointerEventHandler | undefinedDOMAttributes
onPointerCancelCapturePointerEventHandler | undefinedDOMAttributes
onPointerEnterPointerEventHandler | undefinedDOMAttributes
onPointerEnterCapturePointerEventHandler | undefinedDOMAttributes
onPointerLeavePointerEventHandler | undefinedDOMAttributes
onPointerLeaveCapturePointerEventHandler | undefinedDOMAttributes
onPointerOverPointerEventHandler | undefinedDOMAttributes
onPointerOverCapturePointerEventHandler | undefinedDOMAttributes
onPointerOutPointerEventHandler | undefinedDOMAttributes
onPointerOutCapturePointerEventHandler | undefinedDOMAttributes
onGotPointerCapturePointerEventHandler | undefinedDOMAttributes
onGotPointerCaptureCapturePointerEventHandler | undefinedDOMAttributes
onLostPointerCapturePointerEventHandler | undefinedDOMAttributes
onLostPointerCaptureCapturePointerEventHandler | undefinedDOMAttributes
onScrollUIEventHandler | undefinedDOMAttributes
onScrollCaptureUIEventHandler | undefinedDOMAttributes
onWheelWheelEventHandler | undefinedDOMAttributes
onWheelCaptureWheelEventHandler | undefinedDOMAttributes
onAnimationStartAnimationEventHandler | undefinedDOMAttributes
onAnimationStartCaptureAnimationEventHandler | undefinedDOMAttributes
onAnimationEndAnimationEventHandler | undefinedDOMAttributes
onAnimationEndCaptureAnimationEventHandler | undefinedDOMAttributes
onAnimationIterationAnimationEventHandler | undefinedDOMAttributes
onAnimationIterationCaptureAnimationEventHandler | undefinedDOMAttributes
onTransitionEndTransitionEventHandler | undefinedDOMAttributes
onTransitionEndCaptureTransitionEventHandler | undefinedDOMAttributes
as
React.ElementType
at*: function (
index*: number
) => T | undefined
BoxOwnProps
variantstringBoxOwnProps
cssInterpolationPrimitive | ArrayInterpolation<> | FunctionInterpolation<>BoxOwnProps
mResponsiveValue | undefinedSpacePropsMargin on top, left, bottom and right
marginResponsiveValue | undefinedSpacePropsMargin on top, left, bottom and right
mtResponsiveValue | undefinedSpacePropsMargin on top
marginTopResponsiveValue | undefinedSpacePropsMargin on top
mrResponsiveValue | undefinedSpacePropsMargin on right
marginRightResponsiveValue | undefinedSpacePropsMargin on right
mbResponsiveValue | undefinedSpacePropsMargin on bottom
marginBottomResponsiveValue | undefinedSpacePropsMargin on bottom
mlResponsiveValue | undefinedSpacePropsMargin on left
marginLeftResponsiveValue | undefinedSpacePropsMargin on left
mxResponsiveValue | undefinedSpacePropsMargin on left and right
marginXResponsiveValue | undefinedSpacePropsMargin on left and right
myResponsiveValue | undefinedSpacePropsMargin on top and bottom
marginYResponsiveValue | undefinedSpacePropsMargin on top and bottom
paddingResponsiveValue | undefinedSpacePropsPadding on top, left, bottom and right
ptResponsiveValue | undefinedSpacePropsPadding on top
paddingTopResponsiveValue | undefinedSpacePropsPadding on top
prResponsiveValue | undefinedSpacePropsPadding on right
paddingRightResponsiveValue | undefinedSpacePropsPadding on right
pbResponsiveValue | undefinedSpacePropsPadding on bottom
paddingBottomResponsiveValue | undefinedSpacePropsPadding on bottom
plResponsiveValue | undefinedSpacePropsPadding on left
paddingLeftResponsiveValue | undefinedSpacePropsPadding on left
pxResponsiveValue | undefinedSpacePropsPadding on left and right
paddingXResponsiveValue | undefinedSpacePropsPadding on left and right
pyResponsiveValue | undefinedSpacePropsPadding on top and bottom
paddingYResponsiveValue | undefinedSpacePropsPadding on top and bottom
bgResponsiveValue | undefinedBackgroundColorPropsThe 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)
backgroundColorResponsiveValue | undefinedBackgroundColorProps
opacityResponsiveValue | undefinedOpacityPropsThe 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)

react component

native lonk to the documentation

defined in @component-controls/app/ui/app/src/Links/DocsLink.tsx

properties

NameTypeParentDescription
typestring | undefinedAnchorHTMLAttributes
pResponsiveValue | undefinedSpacePropsPadding on top, left, bottom and right
slotstring | undefinedHTMLAttributes
styleCSSProperties | undefinedHTMLAttributes
titlestring | undefinedHTMLAttributes
refExclude<R, string> | undefinedPropsWithRef
keyKey | null | undefinedAttributes
sxThemeUICSSObject | ThemeDerivedStylesAttributesThe 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.
downloadanyAnchorHTMLAttributes
hrefLangstring | undefinedAnchorHTMLAttributes
mediastring | undefinedAnchorHTMLAttributes
pingstring | undefinedAnchorHTMLAttributes
relstring | undefinedAnchorHTMLAttributes
targetHTMLAttributeAnchorTarget | undefinedAnchorHTMLAttributes
referrerPolicyHTMLAttributeReferrerPolicy | undefinedAnchorHTMLAttributes
defaultCheckedboolean | undefinedHTMLAttributes
defaultValuestring | number | ReadonlyArray<string> | undefinedHTMLAttributes
suppressContentEditableWarningboolean | undefinedHTMLAttributes
suppressHydrationWarningboolean | undefinedHTMLAttributes
accessKeystring | undefinedHTMLAttributes
classNamestring | undefinedHTMLAttributes
contentEditableBooleanish | "inherit" | undefinedHTMLAttributes
contextMenustring | undefinedHTMLAttributes
dirstring | undefinedHTMLAttributes
draggableBooleanish | undefinedHTMLAttributes
hiddenboolean | undefinedHTMLAttributes
idstring | undefinedHTMLAttributes
langstring | undefinedHTMLAttributes
placeholderstring | undefinedHTMLAttributes
spellCheckBooleanish | undefinedHTMLAttributes
tabIndexnumber | undefinedHTMLAttributes
translate"yes" | "no" | undefinedHTMLAttributes
radioGroupstring | undefinedHTMLAttributes
roleAriaRole | undefinedHTMLAttributes
aboutstring | undefinedHTMLAttributes
datatypestring | undefinedHTMLAttributes
inlistanyHTMLAttributes
prefixstring | undefinedHTMLAttributes
propertystring | undefinedHTMLAttributes
resourcestring | undefinedHTMLAttributes
typeofstring | undefinedHTMLAttributes
vocabstring | undefinedHTMLAttributes
autoCapitalizestring | undefinedHTMLAttributes
autoCorrectstring | undefinedHTMLAttributes
autoSavestring | undefinedHTMLAttributes
colorstring | undefinedHTMLAttributes
itemPropstring | undefinedHTMLAttributes
itemScopeboolean | undefinedHTMLAttributes
itemTypestring | undefinedHTMLAttributes
itemIDstring | undefinedHTMLAttributes
itemRefstring | undefinedHTMLAttributes
resultsnumber | undefinedHTMLAttributes
securitystring | undefinedHTMLAttributes
unselectable"on" | "off" | undefinedHTMLAttributes
inputMode"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefinedHTMLAttributesHints at the type of data that might be entered by the user while editing the element or its contents
isstring | undefinedHTMLAttributesSpecify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendantstring | undefinedAriaAttributesIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "false" | "true" | undefinedAriaAttributesIndicates 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" | undefinedAriaAttributesIndicates 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-busyboolean | "false" | "true" | undefinedAriaAttributesIndicates 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-checkedboolean | "false" | "mixed" | "true" | undefinedAriaAttributesIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber | undefinedAriaAttributesDefines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber | undefinedAriaAttributesDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colspannumber | undefinedAriaAttributesDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring | undefinedAriaAttributesIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefinedAriaAttributesIndicates the element that represents the current item within a container or set of related elements.
aria-describedbystring | undefinedAriaAttributesIdentifies the element (or elements) that describes the object.
aria-detailsstring | undefinedAriaAttributesIdentifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "false" | "true" | undefinedAriaAttributesIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"none" | "copy" | "execute" | "link" | "move" | "popup" | undefinedAriaAttributesIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring | undefinedAriaAttributesIdentifies the element that provides an error message for the object.
aria-expandedboolean | "false" | "true" | undefinedAriaAttributesIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring | undefinedAriaAttributesIdentifies 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-grabbedboolean | "false" | "true" | undefinedAriaAttributesIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefinedAriaAttributesIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "false" | "true" | undefinedAriaAttributesIndicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "false" | "true" | "grammar" | "spelling" | undefinedAriaAttributesIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring | undefinedAriaAttributesIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring | undefinedAriaAttributesDefines a string value that labels the current element.
aria-labelledbystring | undefinedAriaAttributesIdentifies the element (or elements) that labels the current element.
aria-levelnumber | undefinedAriaAttributesDefines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite" | undefinedAriaAttributesIndicates 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-modalboolean | "false" | "true" | undefinedAriaAttributesIndicates whether an element is modal when displayed.
aria-multilineboolean | "false" | "true" | undefinedAriaAttributesIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "false" | "true" | undefinedAriaAttributesIndicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical" | undefinedAriaAttributesIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring | undefinedAriaAttributesIdentifies 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-placeholderstring | undefinedAriaAttributesDefines 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-posinsetnumber | undefinedAriaAttributesDefines 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-pressedboolean | "false" | "mixed" | "true" | undefinedAriaAttributesIndicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "false" | "true" | undefinedAriaAttributesIndicates 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" | undefinedAriaAttributesIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "false" | "true" | undefinedAriaAttributesIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring | undefinedAriaAttributesDefines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber | undefinedAriaAttributesDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber | undefinedAriaAttributesDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowspannumber | undefinedAriaAttributesDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "false" | "true" | undefinedAriaAttributesIndicates the current "selected" state of various widgets.
aria-setsizenumber | undefinedAriaAttributesDefines 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" | undefinedAriaAttributesIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber | undefinedAriaAttributesDefines the maximum allowed value for a range widget.
aria-valueminnumber | undefinedAriaAttributesDefines the minimum allowed value for a range widget.
aria-valuenownumber | undefinedAriaAttributesDefines the current value for a range widget.
aria-valuetextstring | undefinedAriaAttributesDefines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTMLtype | undefinedDOMAttributes
onCopyClipboardEventHandler | undefinedDOMAttributes
onCopyCaptureClipboardEventHandler | undefinedDOMAttributes
onCutClipboardEventHandler | undefinedDOMAttributes
onCutCaptureClipboardEventHandler | undefinedDOMAttributes
onPasteClipboardEventHandler | undefinedDOMAttributes
onPasteCaptureClipboardEventHandler | undefinedDOMAttributes
onCompositionEndCompositionEventHandler | undefinedDOMAttributes
onCompositionEndCaptureCompositionEventHandler | undefinedDOMAttributes
onCompositionStartCompositionEventHandler | undefinedDOMAttributes
onCompositionStartCaptureCompositionEventHandler | undefinedDOMAttributes
onCompositionUpdateCompositionEventHandler | undefinedDOMAttributes
onCompositionUpdateCaptureCompositionEventHandler | undefinedDOMAttributes
onFocusFocusEventHandler | undefinedDOMAttributes
onFocusCaptureFocusEventHandler | undefinedDOMAttributes
onBlurFocusEventHandler | undefinedDOMAttributes
onBlurCaptureFocusEventHandler | undefinedDOMAttributes
onChangeFormEventHandler | undefinedDOMAttributes
onChangeCaptureFormEventHandler | undefinedDOMAttributes
onBeforeInputFormEventHandler | undefinedDOMAttributes
onBeforeInputCaptureFormEventHandler | undefinedDOMAttributes
onInputFormEventHandler | undefinedDOMAttributes
onInputCaptureFormEventHandler | undefinedDOMAttributes
onResetFormEventHandler | undefinedDOMAttributes
onResetCaptureFormEventHandler | undefinedDOMAttributes
onSubmitFormEventHandler | undefinedDOMAttributes
onSubmitCaptureFormEventHandler | undefinedDOMAttributes
onInvalidFormEventHandler | undefinedDOMAttributes
onInvalidCaptureFormEventHandler | undefinedDOMAttributes
onLoadReactEventHandler | undefinedDOMAttributes
onLoadCaptureReactEventHandler | undefinedDOMAttributes
onErrorReactEventHandler | undefinedDOMAttributes
onErrorCaptureReactEventHandler | undefinedDOMAttributes
onKeyDownKeyboardEventHandler | undefinedDOMAttributes
onKeyDownCaptureKeyboardEventHandler | undefinedDOMAttributes
onKeyPressKeyboardEventHandler | undefinedDOMAttributes
onKeyPressCaptureKeyboardEventHandler | undefinedDOMAttributes
onKeyUpKeyboardEventHandler | undefinedDOMAttributes
onKeyUpCaptureKeyboardEventHandler | undefinedDOMAttributes
onAbortReactEventHandler | undefinedDOMAttributes
onAbortCaptureReactEventHandler | undefinedDOMAttributes
onCanPlayReactEventHandler | undefinedDOMAttributes
onCanPlayCaptureReactEventHandler | undefinedDOMAttributes
onCanPlayThroughReactEventHandler | undefinedDOMAttributes
onCanPlayThroughCaptureReactEventHandler | undefinedDOMAttributes
onDurationChangeReactEventHandler | undefinedDOMAttributes
onDurationChangeCaptureReactEventHandler | undefinedDOMAttributes
onEmptiedReactEventHandler | undefinedDOMAttributes
onEmptiedCaptureReactEventHandler | undefinedDOMAttributes
onEncryptedReactEventHandler | undefinedDOMAttributes
onEncryptedCaptureReactEventHandler | undefinedDOMAttributes
onEndedReactEventHandler | undefinedDOMAttributes
onEndedCaptureReactEventHandler | undefinedDOMAttributes
onLoadedDataReactEventHandler | undefinedDOMAttributes
onLoadedDataCaptureReactEventHandler | undefinedDOMAttributes
onLoadedMetadataReactEventHandler | undefinedDOMAttributes
onLoadedMetadataCaptureReactEventHandler | undefinedDOMAttributes
onLoadStartReactEventHandler | undefinedDOMAttributes
onLoadStartCaptureReactEventHandler | undefinedDOMAttributes
onPauseReactEventHandler | undefinedDOMAttributes
onPauseCaptureReactEventHandler | undefinedDOMAttributes
onPlayReactEventHandler | undefinedDOMAttributes
onPlayCaptureReactEventHandler | undefinedDOMAttributes
onPlayingReactEventHandler | undefinedDOMAttributes
onPlayingCaptureReactEventHandler | undefinedDOMAttributes
onProgressReactEventHandler | undefinedDOMAttributes
onProgressCaptureReactEventHandler | undefinedDOMAttributes
onRateChangeReactEventHandler | undefinedDOMAttributes
onRateChangeCaptureReactEventHandler | undefinedDOMAttributes
onSeekedReactEventHandler | undefinedDOMAttributes
onSeekedCaptureReactEventHandler | undefinedDOMAttributes
onSeekingReactEventHandler | undefinedDOMAttributes
onSeekingCaptureReactEventHandler | undefinedDOMAttributes
onStalledReactEventHandler | undefinedDOMAttributes
onStalledCaptureReactEventHandler | undefinedDOMAttributes
onSuspendReactEventHandler | undefinedDOMAttributes
onSuspendCaptureReactEventHandler | undefinedDOMAttributes
onTimeUpdateReactEventHandler | undefinedDOMAttributes
onTimeUpdateCaptureReactEventHandler | undefinedDOMAttributes
onVolumeChangeReactEventHandler | undefinedDOMAttributes
onVolumeChangeCaptureReactEventHandler | undefinedDOMAttributes
onWaitingReactEventHandler | undefinedDOMAttributes
onWaitingCaptureReactEventHandler | undefinedDOMAttributes
onAuxClickMouseEventHandler | undefinedDOMAttributes
onAuxClickCaptureMouseEventHandler | undefinedDOMAttributes
onClickMouseEventHandler | undefinedDOMAttributes
onClickCaptureMouseEventHandler | undefinedDOMAttributes
onContextMenuMouseEventHandler | undefinedDOMAttributes
onContextMenuCaptureMouseEventHandler | undefinedDOMAttributes
onDoubleClickMouseEventHandler | undefinedDOMAttributes
onDoubleClickCaptureMouseEventHandler | undefinedDOMAttributes
onDragDragEventHandler | undefinedDOMAttributes
onDragCaptureDragEventHandler | undefinedDOMAttributes
onDragEndDragEventHandler | undefinedDOMAttributes
onDragEndCaptureDragEventHandler | undefinedDOMAttributes
onDragEnterDragEventHandler | undefinedDOMAttributes
onDragEnterCaptureDragEventHandler | undefinedDOMAttributes
onDragExitDragEventHandler | undefinedDOMAttributes
onDragExitCaptureDragEventHandler | undefinedDOMAttributes
onDragLeaveDragEventHandler | undefinedDOMAttributes
onDragLeaveCaptureDragEventHandler | undefinedDOMAttributes
onDragOverDragEventHandler | undefinedDOMAttributes
onDragOverCaptureDragEventHandler | undefinedDOMAttributes
onDragStartDragEventHandler | undefinedDOMAttributes
onDragStartCaptureDragEventHandler | undefinedDOMAttributes
onDropDragEventHandler | undefinedDOMAttributes
onDropCaptureDragEventHandler | undefinedDOMAttributes
onMouseDownMouseEventHandler | undefinedDOMAttributes
onMouseDownCaptureMouseEventHandler | undefinedDOMAttributes
onMouseEnterMouseEventHandler | undefinedDOMAttributes
onMouseLeaveMouseEventHandler | undefinedDOMAttributes
onMouseMoveMouseEventHandler | undefinedDOMAttributes
onMouseMoveCaptureMouseEventHandler | undefinedDOMAttributes
onMouseOutMouseEventHandler | undefinedDOMAttributes
onMouseOutCaptureMouseEventHandler | undefinedDOMAttributes
onMouseOverMouseEventHandler | undefinedDOMAttributes
onMouseOverCaptureMouseEventHandler | undefinedDOMAttributes
onMouseUpMouseEventHandler | undefinedDOMAttributes
onMouseUpCaptureMouseEventHandler | undefinedDOMAttributes
onSelectReactEventHandler | undefinedDOMAttributes
onSelectCaptureReactEventHandler | undefinedDOMAttributes
onTouchCancelTouchEventHandler | undefinedDOMAttributes
onTouchCancelCaptureTouchEventHandler | undefinedDOMAttributes
onTouchEndTouchEventHandler | undefinedDOMAttributes
onTouchEndCaptureTouchEventHandler | undefinedDOMAttributes
onTouchMoveTouchEventHandler | undefinedDOMAttributes
onTouchMoveCaptureTouchEventHandler | undefinedDOMAttributes
onTouchStartTouchEventHandler | undefinedDOMAttributes
onTouchStartCaptureTouchEventHandler | undefinedDOMAttributes
onPointerDownPointerEventHandler | undefinedDOMAttributes
onPointerDownCapturePointerEventHandler | undefinedDOMAttributes
onPointerMovePointerEventHandler | undefinedDOMAttributes
onPointerMoveCapturePointerEventHandler | undefinedDOMAttributes
onPointerUpPointerEventHandler | undefinedDOMAttributes
onPointerUpCapturePointerEventHandler | undefinedDOMAttributes
onPointerCancelPointerEventHandler | undefinedDOMAttributes
onPointerCancelCapturePointerEventHandler | undefinedDOMAttributes
onPointerEnterPointerEventHandler | undefinedDOMAttributes
onPointerEnterCapturePointerEventHandler | undefinedDOMAttributes
onPointerLeavePointerEventHandler | undefinedDOMAttributes
onPointerLeaveCapturePointerEventHandler | undefinedDOMAttributes
onPointerOverPointerEventHandler | undefinedDOMAttributes
onPointerOverCapturePointerEventHandler | undefinedDOMAttributes
onPointerOutPointerEventHandler | undefinedDOMAttributes
onPointerOutCapturePointerEventHandler | undefinedDOMAttributes
onGotPointerCapturePointerEventHandler | undefinedDOMAttributes
onGotPointerCaptureCapturePointerEventHandler | undefinedDOMAttributes
onLostPointerCapturePointerEventHandler | undefinedDOMAttributes
onLostPointerCaptureCapturePointerEventHandler | undefinedDOMAttributes
onScrollUIEventHandler | undefinedDOMAttributes
onScrollCaptureUIEventHandler | undefinedDOMAttributes
onWheelWheelEventHandler | undefinedDOMAttributes
onWheelCaptureWheelEventHandler | undefinedDOMAttributes
onAnimationStartAnimationEventHandler | undefinedDOMAttributes
onAnimationStartCaptureAnimationEventHandler | undefinedDOMAttributes
onAnimationEndAnimationEventHandler | undefinedDOMAttributes
onAnimationEndCaptureAnimationEventHandler | undefinedDOMAttributes
onAnimationIterationAnimationEventHandler | undefinedDOMAttributes
onAnimationIterationCaptureAnimationEventHandler | undefinedDOMAttributes
onTransitionEndTransitionEventHandler | undefinedDOMAttributes
onTransitionEndCaptureTransitionEventHandler | undefinedDOMAttributes
as
React.ElementType
at*: function (
index*: number
) => T | undefined
BoxOwnProps
variantstringBoxOwnProps
cssInterpolationPrimitive | ArrayInterpolation<> | FunctionInterpolation<>BoxOwnProps
mResponsiveValue | undefinedSpacePropsMargin on top, left, bottom and right
marginResponsiveValue | undefinedSpacePropsMargin on top, left, bottom and right
mtResponsiveValue | undefinedSpacePropsMargin on top
marginTopResponsiveValue | undefinedSpacePropsMargin on top
mrResponsiveValue | undefinedSpacePropsMargin on right
marginRightResponsiveValue | undefinedSpacePropsMargin on right
mbResponsiveValue | undefinedSpacePropsMargin on bottom
marginBottomResponsiveValue | undefinedSpacePropsMargin on bottom
mlResponsiveValue | undefinedSpacePropsMargin on left
marginLeftResponsiveValue | undefinedSpacePropsMargin on left
mxResponsiveValue | undefinedSpacePropsMargin on left and right
marginXResponsiveValue | undefinedSpacePropsMargin on left and right
myResponsiveValue | undefinedSpacePropsMargin on top and bottom
marginYResponsiveValue | undefinedSpacePropsMargin on top and bottom
paddingResponsiveValue | undefinedSpacePropsPadding on top, left, bottom and right
ptResponsiveValue | undefinedSpacePropsPadding on top
paddingTopResponsiveValue | undefinedSpacePropsPadding on top
prResponsiveValue | undefinedSpacePropsPadding on right
paddingRightResponsiveValue | undefinedSpacePropsPadding on right
pbResponsiveValue | undefinedSpacePropsPadding on bottom
paddingBottomResponsiveValue | undefinedSpacePropsPadding on bottom
plResponsiveValue | undefinedSpacePropsPadding on left
paddingLeftResponsiveValue | undefinedSpacePropsPadding on left
pxResponsiveValue | undefinedSpacePropsPadding on left and right
paddingXResponsiveValue | undefinedSpacePropsPadding on left and right
pyResponsiveValue | undefinedSpacePropsPadding on top and bottom
paddingYResponsiveValue | undefinedSpacePropsPadding on top and bottom
bgResponsiveValue | undefinedBackgroundColorPropsThe 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)
backgroundColorResponsiveValue | undefinedBackgroundColorProps
opacityResponsiveValue | undefinedOpacityPropsThe 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)

react component

native lonk to a documentation page

defined in @component-controls/app/ui/app/src/Links/DocLink.tsx

properties

NameTypeParentDescription
id*stringDocLinkProps
typestring | undefinedAnchorHTMLAttributes
pResponsiveValue | undefinedSpacePropsPadding on top, left, bottom and right
slotstring | undefinedHTMLAttributes
styleCSSProperties | undefinedHTMLAttributes
titlestring | undefinedHTMLAttributes
refExclude<R, string> | undefinedPropsWithRef
keyKey | null | undefinedAttributes
sxThemeUICSSObject | ThemeDerivedStylesAttributesThe 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.
downloadanyAnchorHTMLAttributes
hrefLangstring | undefinedAnchorHTMLAttributes
mediastring | undefinedAnchorHTMLAttributes
pingstring | undefinedAnchorHTMLAttributes
relstring | undefinedAnchorHTMLAttributes
targetHTMLAttributeAnchorTarget | undefinedAnchorHTMLAttributes
referrerPolicyHTMLAttributeReferrerPolicy | undefinedAnchorHTMLAttributes
defaultCheckedboolean | undefinedHTMLAttributes
defaultValuestring | number | ReadonlyArray<string> | undefinedHTMLAttributes
suppressContentEditableWarningboolean | undefinedHTMLAttributes
suppressHydrationWarningboolean | undefinedHTMLAttributes
accessKeystring | undefinedHTMLAttributes
classNamestring | undefinedHTMLAttributes
contentEditableBooleanish | "inherit" | undefinedHTMLAttributes
contextMenustring | undefinedHTMLAttributes
dirstring | undefinedHTMLAttributes
draggableBooleanish | undefinedHTMLAttributes
hiddenboolean | undefinedHTMLAttributes
langstring | undefinedHTMLAttributes
placeholderstring | undefinedHTMLAttributes
spellCheckBooleanish | undefinedHTMLAttributes
tabIndexnumber | undefinedHTMLAttributes
translate"yes" | "no" | undefinedHTMLAttributes
radioGroupstring | undefinedHTMLAttributes
roleAriaRole | undefinedHTMLAttributes
aboutstring | undefinedHTMLAttributes
datatypestring | undefinedHTMLAttributes
inlistanyHTMLAttributes
prefixstring | undefinedHTMLAttributes
propertystring | undefinedHTMLAttributes
resourcestring | undefinedHTMLAttributes
typeofstring | undefinedHTMLAttributes
vocabstring | undefinedHTMLAttributes
autoCapitalizestring | undefinedHTMLAttributes
autoCorrectstring | undefinedHTMLAttributes
autoSavestring | undefinedHTMLAttributes
colorstring | undefinedHTMLAttributes
itemPropstring | undefinedHTMLAttributes
itemScopeboolean | undefinedHTMLAttributes
itemTypestring | undefinedHTMLAttributes
itemIDstring | undefinedHTMLAttributes
itemRefstring | undefinedHTMLAttributes
resultsnumber | undefinedHTMLAttributes
securitystring | undefinedHTMLAttributes
unselectable"on" | "off" | undefinedHTMLAttributes
inputMode"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefinedHTMLAttributesHints at the type of data that might be entered by the user while editing the element or its contents
isstring | undefinedHTMLAttributesSpecify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendantstring | undefinedAriaAttributesIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "false" | "true" | undefinedAriaAttributesIndicates 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" | undefinedAriaAttributesIndicates 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-busyboolean | "false" | "true" | undefinedAriaAttributesIndicates 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-checkedboolean | "false" | "mixed" | "true" | undefinedAriaAttributesIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber | undefinedAriaAttributesDefines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber | undefinedAriaAttributesDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colspannumber | undefinedAriaAttributesDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring | undefinedAriaAttributesIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefinedAriaAttributesIndicates the element that represents the current item within a container or set of related elements.
aria-describedbystring | undefinedAriaAttributesIdentifies the element (or elements) that describes the object.
aria-detailsstring | undefinedAriaAttributesIdentifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "false" | "true" | undefinedAriaAttributesIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"none" | "copy" | "execute" | "link" | "move" | "popup" | undefinedAriaAttributesIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring | undefinedAriaAttributesIdentifies the element that provides an error message for the object.
aria-expandedboolean | "false" | "true" | undefinedAriaAttributesIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring | undefinedAriaAttributesIdentifies 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-grabbedboolean | "false" | "true" | undefinedAriaAttributesIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefinedAriaAttributesIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "false" | "true" | undefinedAriaAttributesIndicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "false" | "true" | "grammar" | "spelling" | undefinedAriaAttributesIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring | undefinedAriaAttributesIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring | undefinedAriaAttributesDefines a string value that labels the current element.
aria-labelledbystring | undefinedAriaAttributesIdentifies the element (or elements) that labels the current element.
aria-levelnumber | undefinedAriaAttributesDefines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite" | undefinedAriaAttributesIndicates 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-modalboolean | "false" | "true" | undefinedAriaAttributesIndicates whether an element is modal when displayed.
aria-multilineboolean | "false" | "true" | undefinedAriaAttributesIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "false" | "true" | undefinedAriaAttributesIndicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical" | undefinedAriaAttributesIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring | undefinedAriaAttributesIdentifies 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-placeholderstring | undefinedAriaAttributesDefines 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-posinsetnumber | undefinedAriaAttributesDefines 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-pressedboolean | "false" | "mixed" | "true" | undefinedAriaAttributesIndicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "false" | "true" | undefinedAriaAttributesIndicates 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" | undefinedAriaAttributesIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "false" | "true" | undefinedAriaAttributesIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring | undefinedAriaAttributesDefines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber | undefinedAriaAttributesDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber | undefinedAriaAttributesDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowspannumber | undefinedAriaAttributesDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "false" | "true" | undefinedAriaAttributesIndicates the current "selected" state of various widgets.
aria-setsizenumber | undefinedAriaAttributesDefines 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" | undefinedAriaAttributesIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber | undefinedAriaAttributesDefines the maximum allowed value for a range widget.
aria-valueminnumber | undefinedAriaAttributesDefines the minimum allowed value for a range widget.
aria-valuenownumber | undefinedAriaAttributesDefines the current value for a range widget.
aria-valuetextstring | undefinedAriaAttributesDefines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTMLtype | undefinedDOMAttributes
onCopyClipboardEventHandler | undefinedDOMAttributes
onCopyCaptureClipboardEventHandler | undefinedDOMAttributes
onCutClipboardEventHandler | undefinedDOMAttributes
onCutCaptureClipboardEventHandler | undefinedDOMAttributes
onPasteClipboardEventHandler | undefinedDOMAttributes
onPasteCaptureClipboardEventHandler | undefinedDOMAttributes
onCompositionEndCompositionEventHandler | undefinedDOMAttributes
onCompositionEndCaptureCompositionEventHandler | undefinedDOMAttributes
onCompositionStartCompositionEventHandler | undefinedDOMAttributes
onCompositionStartCaptureCompositionEventHandler | undefinedDOMAttributes
onCompositionUpdateCompositionEventHandler | undefinedDOMAttributes
onCompositionUpdateCaptureCompositionEventHandler | undefinedDOMAttributes
onFocusFocusEventHandler | undefinedDOMAttributes
onFocusCaptureFocusEventHandler | undefinedDOMAttributes
onBlurFocusEventHandler | undefinedDOMAttributes
onBlurCaptureFocusEventHandler | undefinedDOMAttributes
onChangeFormEventHandler | undefinedDOMAttributes
onChangeCaptureFormEventHandler | undefinedDOMAttributes
onBeforeInputFormEventHandler | undefinedDOMAttributes
onBeforeInputCaptureFormEventHandler | undefinedDOMAttributes
onInputFormEventHandler | undefinedDOMAttributes
onInputCaptureFormEventHandler | undefinedDOMAttributes
onResetFormEventHandler | undefinedDOMAttributes
onResetCaptureFormEventHandler | undefinedDOMAttributes
onSubmitFormEventHandler | undefinedDOMAttributes
onSubmitCaptureFormEventHandler | undefinedDOMAttributes
onInvalidFormEventHandler | undefinedDOMAttributes
onInvalidCaptureFormEventHandler | undefinedDOMAttributes
onLoadReactEventHandler | undefinedDOMAttributes
onLoadCaptureReactEventHandler | undefinedDOMAttributes
onErrorReactEventHandler | undefinedDOMAttributes
onErrorCaptureReactEventHandler | undefinedDOMAttributes
onKeyDownKeyboardEventHandler | undefinedDOMAttributes
onKeyDownCaptureKeyboardEventHandler | undefinedDOMAttributes
onKeyPressKeyboardEventHandler | undefinedDOMAttributes
onKeyPressCaptureKeyboardEventHandler | undefinedDOMAttributes
onKeyUpKeyboardEventHandler | undefinedDOMAttributes
onKeyUpCaptureKeyboardEventHandler | undefinedDOMAttributes
onAbortReactEventHandler | undefinedDOMAttributes
onAbortCaptureReactEventHandler | undefinedDOMAttributes
onCanPlayReactEventHandler | undefinedDOMAttributes
onCanPlayCaptureReactEventHandler | undefinedDOMAttributes
onCanPlayThroughReactEventHandler | undefinedDOMAttributes
onCanPlayThroughCaptureReactEventHandler | undefinedDOMAttributes
onDurationChangeReactEventHandler | undefinedDOMAttributes
onDurationChangeCaptureReactEventHandler | undefinedDOMAttributes
onEmptiedReactEventHandler | undefinedDOMAttributes
onEmptiedCaptureReactEventHandler | undefinedDOMAttributes
onEncryptedReactEventHandler | undefinedDOMAttributes
onEncryptedCaptureReactEventHandler | undefinedDOMAttributes
onEndedReactEventHandler | undefinedDOMAttributes
onEndedCaptureReactEventHandler | undefinedDOMAttributes
onLoadedDataReactEventHandler | undefinedDOMAttributes
onLoadedDataCaptureReactEventHandler | undefinedDOMAttributes
onLoadedMetadataReactEventHandler | undefinedDOMAttributes
onLoadedMetadataCaptureReactEventHandler | undefinedDOMAttributes
onLoadStartReactEventHandler | undefinedDOMAttributes
onLoadStartCaptureReactEventHandler | undefinedDOMAttributes
onPauseReactEventHandler | undefinedDOMAttributes
onPauseCaptureReactEventHandler | undefinedDOMAttributes
onPlayReactEventHandler | undefinedDOMAttributes
onPlayCaptureReactEventHandler | undefinedDOMAttributes
onPlayingReactEventHandler | undefinedDOMAttributes
onPlayingCaptureReactEventHandler | undefinedDOMAttributes
onProgressReactEventHandler | undefinedDOMAttributes
onProgressCaptureReactEventHandler | undefinedDOMAttributes
onRateChangeReactEventHandler | undefinedDOMAttributes
onRateChangeCaptureReactEventHandler | undefinedDOMAttributes
onSeekedReactEventHandler | undefinedDOMAttributes
onSeekedCaptureReactEventHandler | undefinedDOMAttributes
onSeekingReactEventHandler | undefinedDOMAttributes
onSeekingCaptureReactEventHandler | undefinedDOMAttributes
onStalledReactEventHandler | undefinedDOMAttributes
onStalledCaptureReactEventHandler | undefinedDOMAttributes
onSuspendReactEventHandler | undefinedDOMAttributes
onSuspendCaptureReactEventHandler | undefinedDOMAttributes
onTimeUpdateReactEventHandler | undefinedDOMAttributes
onTimeUpdateCaptureReactEventHandler | undefinedDOMAttributes
onVolumeChangeReactEventHandler | undefinedDOMAttributes
onVolumeChangeCaptureReactEventHandler | undefinedDOMAttributes
onWaitingReactEventHandler | undefinedDOMAttributes
onWaitingCaptureReactEventHandler | undefinedDOMAttributes
onAuxClickMouseEventHandler | undefinedDOMAttributes
onAuxClickCaptureMouseEventHandler | undefinedDOMAttributes
onClickMouseEventHandler | undefinedDOMAttributes
onClickCaptureMouseEventHandler | undefinedDOMAttributes
onContextMenuMouseEventHandler | undefinedDOMAttributes
onContextMenuCaptureMouseEventHandler | undefinedDOMAttributes
onDoubleClickMouseEventHandler | undefinedDOMAttributes
onDoubleClickCaptureMouseEventHandler | undefinedDOMAttributes
onDragDragEventHandler | undefinedDOMAttributes
onDragCaptureDragEventHandler | undefinedDOMAttributes
onDragEndDragEventHandler | undefinedDOMAttributes
onDragEndCaptureDragEventHandler | undefinedDOMAttributes
onDragEnterDragEventHandler | undefinedDOMAttributes
onDragEnterCaptureDragEventHandler | undefinedDOMAttributes
onDragExitDragEventHandler | undefinedDOMAttributes
onDragExitCaptureDragEventHandler | undefinedDOMAttributes
onDragLeaveDragEventHandler | undefinedDOMAttributes
onDragLeaveCaptureDragEventHandler | undefinedDOMAttributes
onDragOverDragEventHandler | undefinedDOMAttributes
onDragOverCaptureDragEventHandler | undefinedDOMAttributes
onDragStartDragEventHandler | undefinedDOMAttributes
onDragStartCaptureDragEventHandler | undefinedDOMAttributes
onDropDragEventHandler | undefinedDOMAttributes
onDropCaptureDragEventHandler | undefinedDOMAttributes
onMouseDownMouseEventHandler | undefinedDOMAttributes
onMouseDownCaptureMouseEventHandler | undefinedDOMAttributes
onMouseEnterMouseEventHandler | undefinedDOMAttributes
onMouseLeaveMouseEventHandler | undefinedDOMAttributes
onMouseMoveMouseEventHandler | undefinedDOMAttributes
onMouseMoveCaptureMouseEventHandler | undefinedDOMAttributes
onMouseOutMouseEventHandler | undefinedDOMAttributes
onMouseOutCaptureMouseEventHandler | undefinedDOMAttributes
onMouseOverMouseEventHandler | undefinedDOMAttributes
onMouseOverCaptureMouseEventHandler | undefinedDOMAttributes
onMouseUpMouseEventHandler | undefinedDOMAttributes
onMouseUpCaptureMouseEventHandler | undefinedDOMAttributes
onSelectReactEventHandler | undefinedDOMAttributes
onSelectCaptureReactEventHandler | undefinedDOMAttributes
onTouchCancelTouchEventHandler | undefinedDOMAttributes
onTouchCancelCaptureTouchEventHandler | undefinedDOMAttributes
onTouchEndTouchEventHandler | undefinedDOMAttributes
onTouchEndCaptureTouchEventHandler | undefinedDOMAttributes
onTouchMoveTouchEventHandler | undefinedDOMAttributes
onTouchMoveCaptureTouchEventHandler | undefinedDOMAttributes
onTouchStartTouchEventHandler | undefinedDOMAttributes
onTouchStartCaptureTouchEventHandler | undefinedDOMAttributes
onPointerDownPointerEventHandler | undefinedDOMAttributes
onPointerDownCapturePointerEventHandler | undefinedDOMAttributes
onPointerMovePointerEventHandler | undefinedDOMAttributes
onPointerMoveCapturePointerEventHandler | undefinedDOMAttributes
onPointerUpPointerEventHandler | undefinedDOMAttributes
onPointerUpCapturePointerEventHandler | undefinedDOMAttributes
onPointerCancelPointerEventHandler | undefinedDOMAttributes
onPointerCancelCapturePointerEventHandler | undefinedDOMAttributes
onPointerEnterPointerEventHandler | undefinedDOMAttributes
onPointerEnterCapturePointerEventHandler | undefinedDOMAttributes
onPointerLeavePointerEventHandler | undefinedDOMAttributes
onPointerLeaveCapturePointerEventHandler | undefinedDOMAttributes
onPointerOverPointerEventHandler | undefinedDOMAttributes
onPointerOverCapturePointerEventHandler | undefinedDOMAttributes
onPointerOutPointerEventHandler | undefinedDOMAttributes
onPointerOutCapturePointerEventHandler | undefinedDOMAttributes
onGotPointerCapturePointerEventHandler | undefinedDOMAttributes
onGotPointerCaptureCapturePointerEventHandler | undefinedDOMAttributes
onLostPointerCapturePointerEventHandler | undefinedDOMAttributes
onLostPointerCaptureCapturePointerEventHandler | undefinedDOMAttributes
onScrollUIEventHandler | undefinedDOMAttributes
onScrollCaptureUIEventHandler | undefinedDOMAttributes
onWheelWheelEventHandler | undefinedDOMAttributes
onWheelCaptureWheelEventHandler | undefinedDOMAttributes
onAnimationStartAnimationEventHandler | undefinedDOMAttributes
onAnimationStartCaptureAnimationEventHandler | undefinedDOMAttributes
onAnimationEndAnimationEventHandler | undefinedDOMAttributes
onAnimationEndCaptureAnimationEventHandler | undefinedDOMAttributes
onAnimationIterationAnimationEventHandler | undefinedDOMAttributes
onAnimationIterationCaptureAnimationEventHandler | undefinedDOMAttributes
onTransitionEndTransitionEventHandler | undefinedDOMAttributes
onTransitionEndCaptureTransitionEventHandler | undefinedDOMAttributes
as
React.ElementType
at*: function (
index*: number
) => T | undefined
BoxOwnProps
variantstringBoxOwnProps
cssInterpolationPrimitive | ArrayInterpolation<> | FunctionInterpolation<>BoxOwnProps
mResponsiveValue | undefinedSpacePropsMargin on top, left, bottom and right
marginResponsiveValue | undefinedSpacePropsMargin on top, left, bottom and right
mtResponsiveValue | undefinedSpacePropsMargin on top
marginTopResponsiveValue | undefinedSpacePropsMargin on top
mrResponsiveValue | undefinedSpacePropsMargin on right
marginRightResponsiveValue | undefinedSpacePropsMargin on right
mbResponsiveValue | undefinedSpacePropsMargin on bottom
marginBottomResponsiveValue | undefinedSpacePropsMargin on bottom
mlResponsiveValue | undefinedSpacePropsMargin on left
marginLeftResponsiveValue | undefinedSpacePropsMargin on left
mxResponsiveValue | undefinedSpacePropsMargin on left and right
marginXResponsiveValue | undefinedSpacePropsMargin on left and right
myResponsiveValue | undefinedSpacePropsMargin on top and bottom
marginYResponsiveValue | undefinedSpacePropsMargin on top and bottom
paddingResponsiveValue | undefinedSpacePropsPadding on top, left, bottom and right
ptResponsiveValue | undefinedSpacePropsPadding on top
paddingTopResponsiveValue | undefinedSpacePropsPadding on top
prResponsiveValue | undefinedSpacePropsPadding on right
paddingRightResponsiveValue | undefinedSpacePropsPadding on right
pbResponsiveValue | undefinedSpacePropsPadding on bottom
paddingBottomResponsiveValue | undefinedSpacePropsPadding on bottom
plResponsiveValue | undefinedSpacePropsPadding on left
paddingLeftResponsiveValue | undefinedSpacePropsPadding on left
pxResponsiveValue | undefinedSpacePropsPadding on left and right
paddingXResponsiveValue | undefinedSpacePropsPadding on left and right
pyResponsiveValue | undefinedSpacePropsPadding on top and bottom
paddingYResponsiveValue | undefinedSpacePropsPadding on top and bottom
bgResponsiveValue | undefinedBackgroundColorPropsThe 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)
backgroundColorResponsiveValue | undefinedBackgroundColorProps
opacityResponsiveValue | undefinedOpacityPropsThe 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)

CategoryList

react component

displays page of categories

defined in @component-controls/app/ui/app/src/CategoryList/CategoryList.tsx

properties

NameTypeParentDescription
type*"story" | "blog" | "page" | "tags" | "author" | stringCategoryListPropsdocument type

SideContext

react component

defined in @component-controls/app/ui/app/src/SideContext/SideContext.tsx

properties

NameType
pageRef
RefObject<>
current*: T | null
tabstring

Container

react component

application inner container for pages. Adds pagination to the blocks/Container component.

defined in @component-controls/app/ui/app/src/Container/Container.tsx

CategoryPage

react component

defined in @component-controls/app/ui/app/src/CategoryPage/CategoryPage.tsx

properties

NameTypeParent
type*"story" | "blog" | "page" | "tags" | "author" | stringCategoryPageProps
category*anyCategoryPageProps

DocPage

react component

documentation page for current document. will check if the page has a layout with sidebars or if the page is standalone.

defined in @component-controls/app/ui/app/src/DocPage/DocPage.tsx

properties

NameTypeParentDescription
type"story" | "blog" | "page" | "tags" | "author" | stringDocPagePropsdocument type
categorystring

DocumentHomePage

react component

list of documents for a specific document type

defined in @component-controls/app/ui/app/src/DocumentHomePage/DocumentHomePage.tsx

properties

NameTypeParent
type"story" | "blog" | "page" | "tags" | "author" | stringDocumentHomePageProps

DocumentsList

react component

displays a list of the provided document pages

defined in @component-controls/app/ui/app/src/DocumentsList/DocumentsList.tsx

properties

NameTypeParentDescription
pages*(Document<>)[]DocumentsListPropslist of document pages
type*"story" | "blog" | "page" | "tags" | "author" | stringDocumentsListPropsdocument type

SidebarsMDXPage

react component

document page - rendering with sidebars and tabs for multiple document views

defined in @component-controls/app/ui/app/src/SidebarsPage/SidebarsMDXPage.tsx

properties

NameTypeParentDescription
type"story" | "blog" | "page" | "tags" | "author" | stringSidebarsMDXPagePropsdocument type
doc*
Document<>
[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*: function (
props: Story<Props>
) => Example<Props>
doc: string
source: string
id: string
storyName: string
rawId: string
storyFn: StoryRenderFn
description: string
loc
start*:
end*:
subtitle: string
dynamic: boolean
dynamicId: string
component
at*: function (
index*: number
) => T | undefined
subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>
smartControls: SmartControls
decorators: StoryRenderFn[]
plugins: any
category: string
controls
[string]: ComponentControl<ExampleControls> | any
stories: string[]
source: string
fileName: string
package: string
testFiles: string[]
testCoverage: string[]
testData: string
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
data
[string]:
type
[string]: ComponentControl<ExampleControls> | any
componentsLookup
[string]: string
MDXPage: any
isMDXComponent: boolean
parameters: any
component: string | Record<string, unknown> | ElementType<Props>
subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>
controls
[string]: ComponentControlText | ComponentControlBoolean | ComponentControlColor | ComponentControlDate | ComponentControlObject<> | ComponentControlButton<> | ComponentControlOptions<> | ComponentControlNumber | ComponentControlArray | ComponentControlFiles
smartControls
smart: boolean
include: string[] | IncludeFn
exclude: string[] | IncludeFn
decorators: StoryRenderFn[]
plugins: any
category: string
navSidebar: boolean
contextSidebar: boolean
fullPage: boolean
SidebarsMDXPagePropsdocument object

SEO

react component

defined in @component-controls/app/ui/app/src/SEO/SEO.tsx

properties

NameTypeParentDefaultDescription
HelmetComponentClass | FunctionComponent<>SEOProps
doc
Document<>
[string]: any
title*: string
type: "story" | "blog" | "page" | "tags" | "author" | string
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*: function (
props*:
) => Example<Props>
doc: string
source: string
id: string
storyName: string
rawId: string
storyFn: StoryRenderFn
description: string
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
[string]: ExampleControl
stories: string[]
source: string
fileName: string
package: string
testFiles: string[]
testCoverage: string[]
testData: string
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
data
[string]:
type
[string]: ExampleControl
componentsLookup
[string]: string
MDXPage: any
isMDXComponent: boolean
parameters: any
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
navSidebar: boolean
contextSidebar: boolean
fullPage: boolean
SEOPropsA documentation file's metadata. For MDX files, fromtmatter is used to declare the document properties. For ESM (ES Modules) documentation files, the default export is used.
config
RunConfiguration
author: string
footer
left: ActionItems
right: ActionItems
menu: StaticMenuItem[]
title: string
image: string
toolbar
left: ActionItems
right: ActionItems
controls
[string]: ComponentControlText | ComponentControlBoolean | ComponentControlColor | ComponentControlDate | ComponentControlObject<P> | ComponentControlButton | ComponentControlOptions | ComponentControlNumber | ComponentControlArray | ComponentControlFiles
description: 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
logo: string | ReactNode
app
propTypes: WeakValidationMap<P> | undefined
contextTypes: ValidationMap<any> | undefined
defaultProps: Partial<P> | undefined
displayName: string | undefined
copyright: string
language: string
links: (DetailedHTMLProps<>)[]
seo: ReactChild | ReactFragment | ReactPortal | boolean | null | undefined
pages
[string]:
type
basePath*:
sideNav*:
label*:
indexHome*:
topMenu*:
container*:
tabs*:
navSidebar*:
contextSidebar*:
fullPage*:
theme
[string]: any
storySort: function (
a*: string
b*: string
) => number
sidebar: ActionItem[]
components: Record<string, unknown>
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
stories: string | string[]
files: string | string[]
siteRoot: string
categories: DocType[]
siteMap: type | boolean
siteUrl: string
instrument: any
tokens
figmaAccessToken: string
githubAccessToken: string
SEOProps
titlestringSEOProps
docType*string""

App

react component

application container component. adds SEO, SkipLinks, Header and Footer.

defined in @component-controls/app/ui/app/src/App/App.tsx

properties

NameTypeParentDefault
HelmetComponentClass | FunctionComponent<>AppProps
typestringAppProps""

AppContext

react component

defined in @component-controls/app/ui/app/src/AppContext/AppContext.tsx

properties

NameTypeParent
docIdstringAppContextProps
storyIdstringAppContextProps
typestringAppContextProps
store*
Store
error: string
config*
author: string
footer
left: ActionItems
right: ActionItems
menu: StaticMenuItem[]
title: string
image: string
toolbar
left: ActionItems
right: ActionItems
controls
[string]: ComponentControlText | ComponentControlBoolean | ComponentControlColor | ComponentControlDate | ComponentControlObject<P> | ComponentControlButton | ComponentControlOptions | ComponentControlNumber | ComponentControlArray | ComponentControlFiles
description: 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
logo: string | ReactNode
app
propTypes: WeakValidationMap<P> | undefined
contextTypes: ValidationMap<any> | undefined
defaultProps: Partial<P> | undefined
displayName*:
copyright: string
language: string
links: (DetailedHTMLProps<>)[]
seo: ReactChild | ReactFragment | ReactPortal | boolean | null | undefined
pages
[string]:
type
basePath*:
sideNav*:
label*:
indexHome*:
topMenu*:
container*:
tabs*:
navSidebar*:
contextSidebar*:
fullPage*:
theme
[string]: any
storySort: function (
a*: string
b*: string
) => number
sidebar: ActionItem[]
components: Record<string, unknown>
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
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*:
doc*:
source*:
id*:
storyName*:
rawId*:
storyFn*:
description*:
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*
[string]:
type
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
at*: function (
index*:
) => T | undefined
subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>
controls: ComponentControls
smartControls: SmartControls
decorators: StoryRenderFn[]
plugins: any
category: string
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
linkClass*
LinkClassType<>
propTypes: WeakValidationMap<> | undefined
contextTypes: ValidationMap<> | undefined
defaultProps: Partial<P> | undefined
displayName: string | undefined
AppContextProps
HelmetComponentClass | FunctionComponent<>AppContextProps
activeTabstringAppContextProps
userDataRecord<string, any>AppContextProps

SidebarsStoryPage

react component

document page - rendering with sidebars and tabs for multiple document views

defined in @component-controls/app/ui/app/src/SidebarsPage/SidebarsStoryPage.tsx

properties

NameTypeParentDescription
type"story" | "blog" | "page" | "tags" | "author" | stringDocPagePropsdocument type
doc*
Document<>
[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*: function (
props: Story<Props>
) => Example<Props>
doc: string
source: string
id: string
storyName: string
rawId: string
storyFn: StoryRenderFn
description: string
loc
start*:
end*:
subtitle: string
dynamic: boolean
dynamicId: string
component
at*: function (
index*: number
) => T | undefined
subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>
smartControls: SmartControls
decorators: StoryRenderFn[]
plugins: any
category: string
controls
[string]: ComponentControl<ExampleControls> | any
stories: string[]
source: string
fileName: string
package: string
testFiles: string[]
testCoverage: string[]
testData: string
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
data
[string]:
type
[string]: ComponentControl<ExampleControls> | any
componentsLookup
[string]: string
MDXPage: any
isMDXComponent: boolean
parameters: any
component: string | Record<string, unknown> | ElementType<Props>
subcomponents: Record<string, (string, Record<string, unknown>, ElementType<Props>)>
controls
[string]: ComponentControlText | ComponentControlBoolean | ComponentControlColor | ComponentControlDate | ComponentControlObject<> | ComponentControlButton<> | ComponentControlOptions<> | ComponentControlNumber | ComponentControlArray | ComponentControlFiles
smartControls
smart: boolean
include: string[] | IncludeFn
exclude: string[] | IncludeFn
decorators: StoryRenderFn[]
plugins: any
category: string
navSidebar: boolean
contextSidebar: boolean
fullPage: boolean
DocPagePropsdocument object

Header

react component

application header component

defined in @component-controls/app/ui/app/src/Header/Header.tsx

properties

NameTypeParent
toolbar
type
left: ActionItem[]
right: ActionItem[]
HeaderProps

Sidebar

react component

application sidebar component

defined in @component-controls/app/ui/app/src/Sidebar/Sidebar.tsx

properties

NameTypeParentDescription
titleReactChild | ReactFragment | ReactPortal | boolean | null | undefinedSidebarPropstitle element
type"story" | "blog" | "page" | "tags" | "author" | stringSidebarPropsdocument type

FAQs

Package last updated on 14 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc