@planningcenter/tapestry-react 2.10.0-rc.8 → 2.10.0

package/dist/types/Button/Button.d.ts

@@ -3,27 +3,86 @@ import { BoxSizes, MediaQueries } from '../index';
 import { StackViewProps } from '../StackView';
 export declare type ButtonProps = {
     children?: any;
+    /**
+     * "Soft disables" button by adding an `aria-disabled` attribute and preventing `onClick` and `keyDown` events for "space" / "enter". This approach allows composing components (such as `Tooltip`) to still bubble up their events, while ensuring that clicking the button or submitting a form is prevented.
+     */
     disabled?: boolean;
+    /**
+     * Opens the linked destination in a new window or tab.
+     */
     external?: boolean;
+    /**
+     * Pass styles for when the button is active.
+     */
     active?: object;
+    /**
+     * Pass styles for when the button is focused.
+     */
     focus?: object;
+    /**
+     * Pass styles for when the button is keyboard-focused.
+     */
     focusVisible?: object;
+    /**
+     * Pass styles for when the button is hovered.
+     */
     hover?: object;
+    /**
+     * Renders an [Icon](/icon) in the center of the button. Pass a string or any valid `Icon` props.
+     * Must pass a [`title`](/button#title) or [`tooltip.title`](/tooltip#title) when using icon-only buttons.
+     */
     icon?: string | Object;
+    /**
+     * Same as above, but renders an icon in the left portion of the button.
+     */
     iconLeft?: string | Object;
+    /**
+     * Same as above, but renders an icon in the right portion of the button.
+     */
     iconRight?: string | Object;
+    /**
+     * Sizes the button using values defined in [boxSizes](/theming)
+     */
     size?: keyof BoxSizes;
+    /**
+     * Renders a [`<Spinner />`](/spinner) in the center of the button. Accepts any valid Spinner props.
+     */
     spinner?: any;
+    /**
+     * Uses a 1:1 ratio for sizing the button.
+     */
     square?: boolean;
+    /**
+     * Uses theme defined in [`buttons.theme`](/theming). Pass `false` to not use theme at all.
+     */
     theme?: string | boolean;
+    /**
+     * Renders a text string in the center of the button.
+     */
     title?: string | number;
+    /**
+     * Where the browser should navigate to when pressed. If you need any element here other than `<a>`, remember to use the `as` prop.
+     */
     to?: string;
+    /**
+     * Where the browser should navigate to when pressed. If you need any element here other than `<a>`, remember to use the `as` prop.
+     */
     href?: string;
+    /**
+     * Wraps button in a [`<Tooltip />`](./tooltip). Accepts any valid Tooltip props.
+     */
     tooltip?: string | Object;
+    /**
+     * Sets the button type to `button`, `submit`, or `reset`. Default is `button`. Type is only valid for `<button>`s.
+     */
     type?: 'button' | 'submit' | 'reset';
+    /**
+     * Determines the modified style of the button.
+     */
     variant?: 'fill' | 'outline' | 'naked';
     onClick?: Function;
     onKeyDown?: Function;
+    /** Describes props at different breakpoints. [Read about mediaQueries](/responsive). */
     mediaQueries?: object;
 } & StackViewProps;
 declare type Props = React.RefAttributes<any> & React.HTMLAttributes<any> & ButtonProps & MediaQueries<ButtonProps>;
@@ -80,4 +139,3 @@ export declare namespace Button {
     }, "slot" | "style" | "title" | "clipPath" | "filter" | "mask" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "border" | "borderBottom" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderLeft" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStyle" | "borderTop" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "clear" | "clip" | "clipRule" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "cursor" | "direction" | "display" | "fillOpacity" | "fillRule" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontSize" | "fontStretch" | "fontStyle" | "fontVariant" | "fontVariantCaps" | "fontVariantLigatures" | "fontVariantNumeric" | "fontWeight" | "gap" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "imageRendering" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBottom" | "marginLeft" | "marginRight" | "marginTop" | "maskType" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "mixBlendMode" | "motion" | "objectFit" | "objectPosition" | "opacity" | "order" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowWrap" | "overflowX" | "overflowY" | "padding" | "paddingBottom" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "perspective" | "perspectiveOrigin" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "resize" | "right" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textDecoration" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "top" | "touchAction" | "transform" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "verticalAlign" | "visibility" | "userSelect" | "WebkitOverflowScrolling" | "writingMode" | "whiteSpace" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "zIndex" | "backgroundColor" | "borderColor" | "borderBottomColor" | "borderLeftColor" | "borderRightColor" | "borderTopColor" | "color" | "fill" | "stroke" | "as" | "children" | "inline" | "innerRef" | "hover" | "mediaQueries" | "variants" | "visible" | "css" | "paddingHorizontal" | "paddingVertical" | "marginHorizontal" | "marginVertical" | "column" | "columnStart" | "columnEnd" | "row" | "rowStart" | "rowEnd" | "basis" | "grow" | "shrink" | "wrap" | "radius" | "radiusTop" | "radiusRight" | "radiusBottom" | "radiusLeft" | "strokeAlign" | "strokeWeight" | "elevation" | "x" | "y" | "rotate" | "scale" | "uppercase" | "className" | "key" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "nonce" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "size" | "onOpen" | "onClose"> & React.RefAttributes<unknown>>;
 }
 export {};
-//# sourceMappingURL=Button.d.ts.map

package/dist/types/Button/Button.test.d.ts

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=Button.test.d.ts.map

package/dist/types/Button/Input.d.ts

@@ -8,12 +8,23 @@ declare type InputProps = {
 };
 declare type InputSignature = (inputProps: InputProps) => ReactNode;
 declare type ButtonInputProps = {
+    /**
+     * Clones immediate child with input specific props. Use a function to access props and pass them yourself.
+     */
     children: InputSignature | ReactElement<any>;
+    /**
+     * Size of internal [Button](/button) and child [Input](/input).
+     */
     size?: 'xs' | 'sm' | 'md' | 'lg';
+    /**
+     * Callback when the input reverts back to a button.
+     */
     onClose: () => void;
+    /**
+     * Callback when button is pressed to reveal the input.
+     */
     onOpen: () => void;
 } & BoxProps;
 declare type Props = RefAttributes<any> & HTMLAttributes<any> & ButtonInputProps;
 declare const ButtonInput: React.ForwardRefExoticComponent<Pick<Props, "slot" | "style" | "title" | "clipPath" | "filter" | "mask" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "border" | "borderBottom" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderLeft" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStyle" | "borderTop" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "clear" | "clip" | "clipRule" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "cursor" | "direction" | "display" | "fillOpacity" | "fillRule" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontSize" | "fontStretch" | "fontStyle" | "fontVariant" | "fontVariantCaps" | "fontVariantLigatures" | "fontVariantNumeric" | "fontWeight" | "gap" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "imageRendering" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBottom" | "marginLeft" | "marginRight" | "marginTop" | "maskType" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "mixBlendMode" | "motion" | "objectFit" | "objectPosition" | "opacity" | "order" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowWrap" | "overflowX" | "overflowY" | "padding" | "paddingBottom" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "perspective" | "perspectiveOrigin" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "resize" | "right" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textDecoration" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "top" | "touchAction" | "transform" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "verticalAlign" | "visibility" | "userSelect" | "WebkitOverflowScrolling" | "writingMode" | "whiteSpace" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "zIndex" | "backgroundColor" | "borderColor" | "borderBottomColor" | "borderLeftColor" | "borderRightColor" | "borderTopColor" | "color" | "fill" | "stroke" | "as" | "children" | "inline" | "innerRef" | "hover" | "mediaQueries" | "variants" | "visible" | "css" | "paddingHorizontal" | "paddingVertical" | "marginHorizontal" | "marginVertical" | "column" | "columnStart" | "columnEnd" | "row" | "rowStart" | "rowEnd" | "basis" | "grow" | "shrink" | "wrap" | "radius" | "radiusTop" | "radiusRight" | "radiusBottom" | "radiusLeft" | "strokeAlign" | "strokeWeight" | "elevation" | "x" | "y" | "rotate" | "scale" | "uppercase" | "className" | "key" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "nonce" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "size" | "onOpen" | "onClose"> & React.RefAttributes<unknown>>;
 export default ButtonInput;
-//# sourceMappingURL=Input.d.ts.map

package/dist/types/Button/index.d.ts

@@ -1,3 +1,2 @@
 export * from './Button';
 export { Button as default } from './Button';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/Calendar/Calendar.d.ts

@@ -1,16 +1,49 @@
 import React from 'react';
 import Day from './Day';
 export declare type CalendarProps = {
+    /**
+     * Gain access to the outer wrapping `StackView` ref
+     */
     calendarRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * Used to calculate the month and year.
+     */
     date?: Date;
+    /**
+     * Used to calculate the initial month and year.
+     */
     initialDate?: Date;
+    /**
+     * The minimum date the calendar can be navigated to.
+     */
     minDate?: Date;
+    /**
+     * The maximum date the calendar can be navigated to.
+     */
     maxDate?: Date;
+    /**
+     * Callback when month or year navigation occurs.
+     */
     onDateChange?: (date: Date) => void;
+    /**
+     * Callback when a day is selected.
+     */
     onDateSelect?: (date: Date) => void;
+    /**
+     * Controls rendering of each day. Returns props that should be forwarded to `Calendar.Day`.
+     */
     renderDay?: (props: Object) => void;
+    /**
+     * Displays a `primary` colored circle around the selected date.
+     */
     selected?: Date;
+    /**
+     * Sets the size of the calendar by changing cell and font sizes.
+     */
     size?: 'sm' | 'md' | 'lg';
+    /**
+     * Determines what day of the week the calendar should start on.
+     */
     weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
 };
 declare type CalendarComponent = React.ForwardRefExoticComponent<CalendarProps & React.RefAttributes<HTMLDivElement>> & {
@@ -27,4 +60,3 @@ declare type CalendarComponent = React.ForwardRefExoticComponent<CalendarProps &
 };
 declare const Calendar: CalendarComponent;
 export default Calendar;
-//# sourceMappingURL=Calendar.d.ts.map

package/dist/types/Card/Card.d.ts

@@ -2,11 +2,12 @@ import * as React from 'react';
 import { StackViewProps } from '../StackView';
 export declare type CardProps = {
     children?: React.ReactNode;
+    /** Adds a slightly higher contrast background. */
     subdued?: boolean;
+    /** The size of the radius. (Default is 3px). */
     radius?: number | string;
 } & StackViewProps;
 export declare function Card({ children, subdued, radius, ...restProps }: CardProps): JSX.Element;
 export declare namespace Card {
     var Section: typeof import("./Section").Section;
 }
-//# sourceMappingURL=Card.d.ts.map

package/dist/types/Card/Section.d.ts

@@ -2,10 +2,10 @@ import * as React from 'react';
 import { StackViewProps } from '../StackView';
 export declare type SectionProps = {
     children?: React.ReactNode;
+    /** Adds a slightly higher contrast background. */
     subdued?: boolean;
 } & StackViewProps & React.RefAttributes<any> & React.HTMLAttributes<any>;
 export declare function Section({ subdued, ...restProps }: SectionProps): JSX.Element;
 export declare namespace Section {
     var displayName: string;
 }
-//# sourceMappingURL=Section.d.ts.map

package/dist/types/Card/index.d.ts

@@ -1,3 +1,2 @@
 export * from './Card';
 export { Card as default } from './Card';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/Checkbox/Checkbox.d.ts

@@ -1,17 +1,51 @@
 import React from 'react';
 export declare type CheckboxProps = {
+    /**
+     * Disables the checkbox component.
+     */
     disabled?: boolean;
+    /**
+     * Used to label the checkbox. Checkbox must have parent label if left `undefined`.
+     * Pass `null` to use as a graphical element only, please note you need to provide
+     * additional aria attributes when doing so.
+     */
     label?: string | null;
+    /**
+     * Connects input to its corrospending label's `htmlFor`.
+     */
     id?: string | number;
+    /**
+     * If `true`, puts the checkbox in an indeterminate state.
+     */
     indeterminate?: boolean;
+    /**
+     * Checks the checkbox, will be overriden if indeterminate is `true`.
+     */
     checked?: boolean;
+    /**
+     * Maps to the internal input's name prop.
+     */
     name?: string;
+    /**
+     * Maps to the internal input's value prop.
+     */
     value?: any;
+    /**
+     * Determines the size of the checkbox based on a [scale](http://google.com).
+     */
     size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    /**
+     * Maps to the internal input's `onChange` prop.
+     */
     onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * Maps to the internal input's `onFocus` prop.
+     */
     onFocus?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * Maps to the internal input's `onBlur` prop.
+     */
     onBlur?: (event: React.ChangeEvent<HTMLInputElement>) => void;
 };
 declare const Checkbox: ({ checked, disabled, id, indeterminate, label, name, onBlur, onChange, onFocus, size, value, ...restProps }: CheckboxProps) => JSX.Element;
 export default Checkbox;
-//# sourceMappingURL=Checkbox.d.ts.map

package/dist/types/CheckboxGroup/CheckboxGroup.d.ts

@@ -1,10 +1,18 @@
 import React from 'react';
 export declare type CheckboxGroupProps = {
     children: React.ReactNode;
+    /**
+     * Maps to the corresponding `Checkbox` name prop.
+     */
     name: string;
+    /**
+     * Callback when any child `Checkbox` fires its `onChange` callback. Receives new array of values.
+     */
     onChange: (value: string[]) => void;
+    /**
+     * Accepts an array of strings that match the corresponding `Checkbox` values that should be checked.
+     */
     value: string[];
 };
 declare const CheckboxGroup: ({ children, name, onChange, value, }: CheckboxGroupProps) => JSX.Element;
 export default CheckboxGroup;
-//# sourceMappingURL=CheckboxGroup.d.ts.map

package/dist/types/CheckboxGroup/CheckboxGroupContext.d.ts

@@ -6,4 +6,3 @@ export declare type CheckboxGroupContextValue = {
 };
 declare const CheckboxGroupContext: import("react").Context<CheckboxGroupContextValue>;
 export default CheckboxGroupContext;
-//# sourceMappingURL=CheckboxGroupContext.d.ts.map

package/dist/types/ChurchCenterStatus/ChurchCenterStatus.d.ts

@@ -1,18 +1,58 @@
 declare type ChurchCenterStatusProps = {
+    /**
+     * Pass props to the Dropdown buttons.
+     */
     buttonProps?: object;
+    /**
+     * Determines status of Church Center App.
+     */
     ccAppEnabled?: boolean;
+    /**
+     * Determines status of publishing to Church Center.
+     */
     ccPublishingEnabled?: boolean;
+    /**
+     * Determines status of Church Center Web.
+     */
     ccWebEnabled?: boolean;
+    /**
+     * Renders a text description in popover when status is active.
+     */
     description: string;
+    /**
+     * Renders a text for Church Center destination button ("Visit {destinationLabel}").
+     */
     destinationLabel: string;
+    /**
+     * Renders a text description in popover when status is inactive.
+     */
     disabledDescription?: string;
+    /**
+     * Pass props to the Dropdown component.
+     */
     dropdownProps?: object;
+    /**
+     * Provide icon overrides for "check", "exclamationTriangle", "external", and "x" icons.
+     */
     icons?: object;
+    /**
+     * Where the browser should navigate when destination button is pressed.
+     */
     productUrl: string;
+    /**
+     * Render nodes at the end of the popover. `buttonProps` is passed as an argument
+     * and can be spread on any `<Button />` component to match the style of the other
+     * popover links.
+     */
     renderPopoverFooter: Function;
+    /**
+     * Where the browser should navigate when settings button is pressed.
+     */
     settingsUrl: string;
+    /**
+     * Toggle the settings link display.
+     */
     showSettingsLink?: boolean;
 };
 export declare function ChurchCenterStatus({ buttonProps: passedButtonProps, ccAppEnabled, ccPublishingEnabled, ccWebEnabled, description, destinationLabel, disabledDescription, dropdownProps, icons, productUrl, renderPopoverFooter, settingsUrl, showSettingsLink, ...props }: ChurchCenterStatusProps): JSX.Element;
 export {};
-//# sourceMappingURL=ChurchCenterStatus.d.ts.map

package/dist/types/ChurchCenterStatus/index.d.ts

@@ -1,3 +1,2 @@
 export * from './ChurchCenterStatus';
 export { ChurchCenterStatus as default } from './ChurchCenterStatus';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/Collapse/Collapse.test.d.ts

@@ -1,2 +1 @@
 import '@testing-library/jest-dom/extend-expect';
-//# sourceMappingURL=Collapse.test.d.ts.map

package/dist/types/Combobox/Combobox.d.ts

@@ -1,9 +1,17 @@
 import React from 'react';
 declare type ComboboxProps = {
+    /**
+     * Usually takes `Combobox.Input`, `Combobox.Items` and `Combobox.Item` components.
+     */
     children: React.ReactNode;
+    /**
+     * Callback when an item is selected.
+     */
     onSelect: (item: any) => void;
+    /**
+     * The value of the selected item.
+     */
     selectedValue: any;
 };
 declare const Combobox: (props: ComboboxProps) => JSX.Element;
 export default Combobox;
-//# sourceMappingURL=Combobox.d.ts.map

package/dist/types/Combobox/ComboboxInput.d.ts

@@ -27,4 +27,3 @@ declare type ComboboxInputRef = {
 };
 declare const ComboboxInput: React.ForwardRefExoticComponent<ComboboxInputProps & React.RefAttributes<ComboboxInputRef>>;
 export default ComboboxInput;
-//# sourceMappingURL=ComboboxInput.d.ts.map

package/dist/types/DateField/DateField.d.ts

@@ -1,16 +1,48 @@
 export declare type DateFieldProps = {
+    /**
+     * Format the displayed date using date-fns [format](https://date-fns.org/v2.0.0-alpha.9/docs/format) function.
+     */
     formatValue: string;
+    /**
+     * Controls the initial Popover state: open or closed (default).
+     */
     defaultOpen: boolean;
+    /**
+     * The minimum date that can be chosen.
+     */
     minDate: Date;
+    /**
+     * The maximum date that can be chosen.
+     */
     maxDate: Date;
+    /**
+     * Called when a date has been selected.
+     */
     onChange: (date: Date) => null;
+    /**
+     * Determines where the popover is placed.
+     */
     placement: string;
+    /**
+     * The date that will be selected.
+     */
     value: Date;
+    /**
+     * Locks external scrollbars when open.
+     */
     lockScrollWhileOpen?: boolean;
+    /**
+     * Attempts to keep popover in view clipping edges if too large.
+     */
     keepInView?: boolean;
+    /**
+     * Accepts any valid [Calendar](/calendar) props.
+     */
     calendarProps?: object;
+    /**
+     * Accepts any valid [Popover](/popover) props.
+     */
     popoverProps?: object;
 };
 declare function DateField({ formatValue, defaultOpen, keepInView, lockScrollWhileOpen, minDate, maxDate, onChange, placement, value, ...props }: DateFieldProps): JSX.Element;
 export default DateField;
-//# sourceMappingURL=DateField.d.ts.map

package/dist/types/DateField/parse.d.ts

@@ -1,9 +1,17 @@
 interface Params {
+    /**
+     * The string we want to parse into a date object
+     */
     date: string;
+    /**
+     * Format hint for parser
+     * Helps us know if we should parse day/month/year or month/day/year
+     *
+     * Should adhere to [date-fns spec](https://date-fns.org/v2.0.0-alpha.9/docs/format).
+     */
     format?: string;
 }
 export declare const parseDate: ({ date, format }: Params) => Date | null;
 export declare const isValidDate: (date: string) => boolean;
 export declare const parseMonth: (monthString: string) => number;
 export {};
-//# sourceMappingURL=parse.d.ts.map

package/dist/types/DateField/parse.test.d.ts

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=parse.test.d.ts.map

package/dist/types/DateField/useArrowKeysToNavigateCalendar.d.ts

@@ -7,4 +7,3 @@ interface Props {
 }
 export declare const useArrowKeysToNavigateCalendar: ({ date, calendarIsOpen, closeCalendar, openCalendar, onChange, }: Props) => (event: React.KeyboardEvent<HTMLInputElement>) => void;
 export {};
-//# sourceMappingURL=useArrowKeysToNavigateCalendar.d.ts.map

package/dist/types/DateField/useEditableDate.d.ts

@@ -1,7 +1,19 @@
 interface Params {
+    /**
+     * The currently selected date
+     */
     date: Date;
+    /**
+     * Format the displayed date using date-fns [format](https://date-fns.org/v2.0.0-alpha.9/docs/format) function.
+     */
     dateFormat: string;
+    /**
+     * Custom function that validates date
+     */
     dateValidator: (date: Date) => boolean;
+    /**
+     * Called when a valid date is entered
+     */
     onChange: (date: Date) => void;
 }
 export declare const useEditableDate: ({ date, dateFormat, dateValidator, onChange }: Params) => {
@@ -11,4 +23,3 @@ export declare const useEditableDate: ({ date, dateFormat, dateValidator, onChan
     invalidKeyBuffer: boolean;
 };
 export {};
-//# sourceMappingURL=useEditableDate.d.ts.map

package/dist/types/Dialog/Dialog.d.ts

@@ -0,0 +1,58 @@
+/** @jsx jsx */
+import React from 'react';
+export declare type DialogProps = {
+    /**
+     * Body of the dialog to display in the main content area.
+     */
+    body: React.ReactNode | string;
+    /**
+     * Text to display on the cancel button.
+     */
+    cancelText?: string;
+    /**
+     * Text to display on the confirm button.
+     */
+    confirmText?: string;
+    /**
+     * Text to display on the destroy button.
+     */
+    destroyText?: string;
+    /**
+     * Create with the `React.useRef()` hook and pass the ref to the dialog.
+     */
+    dialogRef: React.MutableRefObject<HTMLDialogElement>;
+    /**
+     * Callback fired when the cancel button is clicked.
+     */
+    onCancelClick?: () => void;
+    /**
+     * Callback fired when the close (X) button is clicked.
+     */
+    onCloseClick?: () => void;
+    /**
+     * Callback fired when the confirm button is clicked.
+     */
+    onConfirmClick?: () => void;
+    /**
+     * Callback fired when the destroy button is clicked.
+     */
+    onDestroyClick?: () => void;
+    /**
+     * Determines whether the cancel button is shown.
+     */
+    showCancel?: boolean;
+    /**
+     * Determines whether the destroy button is shown.
+     */
+    showDestroy?: boolean;
+    /**
+     * Subtitle of the dialog to display in the header. No subtitle appears if omitted.
+     */
+    subtitle?: string;
+    /**
+     * Title of the dialog to display in the header.
+     */
+    title: string;
+};
+export declare const Dialog: ({ body, cancelText, confirmText, destroyText, dialogRef, onCancelClick, onCloseClick, onConfirmClick, onDestroyClick, showCancel, showDestroy, subtitle, title, }: DialogProps) => JSX.Element;
+export default Dialog;

package/dist/types/Dialog/Dialog.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/Dialog/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Dialog';
+export { Dialog as default } from './Dialog';

package/dist/types/Divider/Divider.d.ts

@@ -1,9 +1,23 @@
 import { ColorProp, StyleProps } from '../index';
 export declare type DividerProps = {
+    /**
+     * The direction the dividing line should span.
+     */
     axis?: 'horizontal' | 'vertical';
+    /**
+     * The color of the line
+     */
     color?: ColorProp;
+    /**
+     * Controls the space on sides opposite to the line's defined axis
+     */
     margin?: number | string;
+    /**
+     * The size of the line in pixels
+     */
     size?: number;
 } & StyleProps;
+/**
+ * Used to break up content
+ */
 export declare function Divider({ axis, color, margin, size, ...restProps }: DividerProps): JSX.Element;
-//# sourceMappingURL=Divider.d.ts.map

package/dist/types/Divider/index.d.ts

@@ -1,3 +1,2 @@
 export * from './Divider';
 export { Divider as default } from './Divider';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/Dropdown/Dropdown.test.d.ts

@@ -1,2 +1 @@
 import '@testing-library/jest-dom/extend-expect';
-//# sourceMappingURL=Dropdown.test.d.ts.map