@planningcenter/tapestry-react 2.10.0-rc.13 → 2.10.0-rc.15

package/dist/types/EditActions/EditActions.d.ts

@@ -1,9 +1,11 @@
 import React from 'react';
 declare type EditActionsProps = {
+    /** Renders any custom component or HTML element when not in the edit state.  */
     display?: React.ReactNode;
+    /** Renders any custom component or HTML element, usually form elments to capture user values. */
     edit?: React.ReactNode;
+    /** Shows a spinner if true and then optimistically shows a checkmark when false again. */
     loading?: boolean;
 };
 declare const EditActions: ({ display, edit, loading, ...restProps }: EditActionsProps) => JSX.Element;
 export default EditActions;
-//# sourceMappingURL=EditActions.d.ts.map

package/dist/types/Field/Field.d.ts

@@ -1,20 +1,33 @@
 import React from 'react';
 declare type FieldProps = {
+    /** Usually accepts form fields, such as `input` or `select`. */
     children?: React.ReactNode;
+    /** Gain access to the internal ref. */
     innerRef?: React.Ref<any>;
+    /** Label that describes field[s]. */
     label?: string | React.ReactNode;
+    /** Label color. */
     labelColor?: string;
+    /** Label flex basis. */
     labelBasis?: string | number;
+    /** Label flex grow. */
     labelGrow?: string | number;
+    /** Renders label and field[s] inline. */
     inline?: boolean;
+    /** Renders label and field[s] smaller. */
     compact?: boolean;
+    /** Renders content into a [HelperDrawer](/helperdrawer) next to label. */
     helpContent?: string | React.ReactNode;
+    /** Helpful text to accompany fields. */
     feedbackText?: string;
+    /** Controls spacing between fields. */
     spacing?: number;
+    /** Controls distribution between fields, by [passing this prop to StackView](/stackview#distribution). (Defaults to "fill".) */
     distribution?: number;
+    /** State of field[s]. */
     state?: 'success' | 'error';
+    /** Places an icon to the left of the label. */
     icon?: any;
 };
 declare const Field: ({ ...props }: FieldProps) => JSX.Element;
 export default Field;
-//# sourceMappingURL=Field.d.ts.map

package/dist/types/FieldSet/FieldSet.d.ts

@@ -4,13 +4,30 @@ import { TileViewProps } from '../TileView';
 import { ToolbarProps } from '../Toolbar';
 declare type FieldSetProps = {
     children?: React.ReactNode;
+    /**
+     * Accepts any valid [Heading](/heading) props.
+     */
     headingProps?: HeadingProps;
+    /**
+     * Maps to internal `Toolbar` prop.
+     */
     helpContent: ToolbarProps['helpContent'];
+    /**
+     * Title of fieldset group.
+     */
     legend: string;
+    /**
+     * Maps to internal `TileView` prop.
+     */
     minCellWidth: TileViewProps['minCellWidth'];
+    /**
+     * Maps to internal `TileView` prop.
+     */
     spacing: TileViewProps['spacing'];
+    /**
+     * Accepts any valid [TileView](/tileview) props.
+     */
     tileViewProps?: TileViewProps;
 };
 declare const FieldSet: ({ children, helpContent, legend, ...restProps }: FieldSetProps) => JSX.Element;
 export default FieldSet;
-//# sourceMappingURL=FieldSet.d.ts.map

package/dist/types/FilterLayout/FilterLayout.d.ts

@@ -1,9 +1,13 @@
 export declare type Props = {
+    /** Render slot for header. */
     header?: any;
+    /** Render slot for sidebar. */
     sidebar?: any;
+    /** Size of sidebar in pixels or `fill` for full width when open. */
     sidebarWidth?: number | 'fill';
+    /** Render slot for table. */
     table?: any;
+    /** Render slot for toolbar. */
     toolbar?: any;
 };
 export declare function FilterLayout(props: Props): JSX.Element;
-//# sourceMappingURL=FilterLayout.d.ts.map

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

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

package/dist/types/GridView/GridView.d.ts

@@ -1,25 +1,41 @@
+/** @jsxRuntime classic */
+/** @jsx jsx */
 import { jsx } from '@emotion/react';
 import * as React from 'react';
 import { BoxProps } from '../Box';
 import { MediaQueries, Variants } from '../index';
 export declare type GridViewProps = {
+    /** Any direct children can use the `column|Start|End` or `row|Start|End` [shorthand properties](/style-props#grid) to place themselves on the grid. */
     children?: any;
+    /** Render custom component or HTML element tag. (Defaults to a `<div>` element). */
     as?: any;
+    /** The algorithm used to implicitly place grid items. Maps to CSS [gridAutoFlow](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) property. */
     autoFlow?: 'column' | 'row' | 'dense';
+    /** The size of implicit grid columns. Maps to CSS [gridAutoColumns](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-columns) property. */
     autoColumns?: string;
+    /** The size of implicit grid rows. Maps to CSS [gridAutoRows](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-rows) property. */
     autoRows?: string;
+    /** The columns of the grid. Maps to CSS [gridTemplateColumns](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) property. */
     columns?: Array<any> | string;
+    /**  If true, sets `display: inline-grid`, otherwise it defaults to `display: grid` */
     inline?: boolean;
+    /** Gain access to the internal ref */
     innerRef?: any;
+    /** The rows of the grid. Maps to CSS [gridTemplateRows](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) property. */
     rows?: Array<any> | string;
+    /** Aligns content in a grid item along the column axis. Maps to CSS [alignItems](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) property. */
     alignment?: 'start' | 'end' | 'center' | 'stretch';
+    /** The amount of space between children. Maps to CSS [gap](https://developer.mozilla.org/en-US/docs/Web/CSS/gap) property. */
     spacing?: number | string;
+    /** The amount of space between columns. Maps to CSS [gridColumnGap](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-gap) property. */
     columnSpacing?: number | string;
+    /** The amount of space between rows. Maps to CSS [gridRowGap](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-gap) property. */
     rowSpacing?: number | string;
+    /** Describes styles at various points in time. [Read about variants](/variants).*/
     variants?: object;
+    /** Describes props at different breakpoints. [Read about mediaQueries](/responsive). */
     mediaQueries?: object;
 } & BoxProps;
 declare type Props = React.RefAttributes<any> & React.HTMLAttributes<any> & GridViewProps & MediaQueries<GridViewProps> & Variants<GridViewProps>;
 export declare function GridView({ as, inline, innerRef, ...props }: Props): jsx.JSX.Element;
 export {};
-//# sourceMappingURL=GridView.d.ts.map

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

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

package/dist/types/Group/Group.d.ts

@@ -1,11 +1,25 @@
 import React from 'react';
 import { StackViewProps } from '../StackView';
 export declare type GroupProps = {
+    /**
+     * The direction the dividing line should span.
+     */
     axis?: 'horizontal' | 'vertical';
+    /**
+     * Props to pass down to all children.
+     */
     childProps?: object;
+    /**
+     * Children elements to be grouped.
+     */
     children?: React.ReactNode;
+    /**
+     * The size of the radius.
+     */
     radius?: number | string;
+    /**
+     * The amount of space or element that is inserted between each child.
+     */
     spacing?: number | string | React.ReactNode;
 } & StackViewProps;
 export declare function Group({ axis, childProps, children, radius, spacing, ...restProps }: GroupProps): JSX.Element;
-//# sourceMappingURL=Group.d.ts.map

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

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

package/dist/types/Heading/Heading.d.ts

@@ -1,8 +1,10 @@
 import React from 'react';
 declare type HeadingProps = {
     children?: React.ReactNode;
+    /** Sets the heading tag (1-6) and the respective font size corresponding to the index position (level - 1) in theme `fontSizes`
+     * `1 | 2 | 3 | 4 | 5 | 6`
+     */
     level?: number;
 };
 declare const Heading: ({ level, ...restProps }: HeadingProps) => JSX.Element;
 export default Heading;
-//# sourceMappingURL=Heading.d.ts.map

package/dist/types/HeadingUppercase/HeadingUppercase.d.ts

@@ -4,4 +4,3 @@ declare type HeadingUppercaseProps = {
 };
 declare const HeadingUppercase: ({ children, ...restProps }: HeadingUppercaseProps) => JSX.Element;
 export default HeadingUppercase;
-//# sourceMappingURL=HeadingUppercase.d.ts.map

package/dist/types/Highlight/Highlight.d.ts

@@ -1,16 +1,30 @@
 declare type HighlightProps = {
+    /**
+     * Color of the highlighted text
+     */
     color: string;
+    /**
+     * The algorithm used to mark the text, defaults to STARTS_WITH
+     */
     marker: (text: string, query: string) => Array<{
         text: string;
         highlight: boolean;
     }>;
+    /**
+     * The query to search for matches
+     */
     query: string;
+    /**
+     * The full string of text to be displayed
+     */
     text: string;
 };
+/**
+ * Highlight or mark letters in a string using a provided query.
+ */
 declare const Highlight: {
     ({ marker, query, text, ...restProps }: HighlightProps): JSX.Element;
     FUZZY: any;
     STARTS_WITH: any;
 };
 export default Highlight;
-//# sourceMappingURL=Highlight.d.ts.map

package/dist/types/Icon/Icon.d.ts

@@ -1,10 +1,13 @@
 import React from 'react';
 declare type IconProps = {
+    /** Accepts the `Icon.Path` component if a `name` is not provided. */
     children?: React.ReactNode;
+    /** The name of the icon to render. */
     name: string;
+    /** Sizes the container proportionally. */
     size?: 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | number | string;
+    /** Pass any valid color from [colors](/colors). Defaults to `currentColor`. */
     color?: string;
 };
 declare const Icon: ({ name, size, color, children, ...props }: IconProps) => JSX.Element;
 export default Icon;
-//# sourceMappingURL=Icon.d.ts.map

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

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

package/dist/types/Logo/Logo.d.ts

@@ -1,7 +1,8 @@
 declare type LogoProps = {
+    /** Accepts `"services"` or `"music-stand"`. */
     name?: string;
+    /** Only displays the "iconmark" portion of the logo and not the wordmark. */
     markOnly?: Boolean;
 };
 declare const Logo: ({ name, markOnly, ...restProps }: LogoProps) => JSX.Element;
 export default Logo;
-//# sourceMappingURL=Logo.d.ts.map

package/dist/types/Modal/Modal.d.ts

@@ -1,11 +1,23 @@
 import React from 'react';
 export declare type ModalProps = {
     children?: React.ReactNode;
+    /**
+     * Close the modal when clicking outside of it.
+     */
     closeOnOutsideClick?: boolean;
+    /**
+     * Called by either clicking on the internal [`<Scrim/>`](/scrim) component or
+     * by pressing the `Escape` key.
+     */
     onRequestClose?: () => null;
+    /**
+     * Determines whether the modal is open or not.
+     */
     open: boolean;
+    /**
+     * Props passed to the internal [`<Scrim/>`](/scrim) component.
+     */
     scrimProps?: Record<string, any>;
 };
 declare const Modal: ({ children, closeOnOutsideClick, onRequestClose, open, ...restProps }: ModalProps) => JSX.Element;
 export default Modal;
-//# sourceMappingURL=Modal.d.ts.map

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

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

package/dist/types/NumberField/NumberField.d.ts

@@ -1,18 +1,58 @@
 import React, { Component } from 'react';
 declare type NumberFieldProps = {
+    /**
+     * Render custom component or HTML element tag. (Defaults to a [InputField](/input.inputfield) component.). */
     as?: any;
+    /**
+     * Add controls to increment/decrement the value
+     */
     hasControls?: boolean;
+    /**
+     * An array of keys to ignore when pushed.
+     * ex: ["ArrowUp", "ArrowDown"].
+     */
     ignoredKeys: string[];
+    /**
+     * Maximum number that can be entered.
+     */
     max: number;
+    /**
+     * Minimum number that can be entered.
+     */
     min: number;
+    /**
+     * Called when the input's onInput is called with a valid value
+     * or when the arrow keys are used to increment/decrement the value.
+     * Please note traditional onInput/onChange events are not supported
+     * since this component takes control of them.
+     */
     onChange: (value: string) => void;
+    /**
+     * Maps to the input's `onBlur` prop.
+     */
     onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
     onInput?: (event: React.FormEvent<HTMLInputElement>) => void;
     onKeyDown?: Function;
+    /**
+     * The amount of 0s to pad the value with.
+     */
     pad: number;
+    /**
+     * Forces the input text to stay fully selected while interacting with it.
+     */
     highlightOnInteraction: boolean;
+    /**
+     * String to display when value is empty.
+     */
     placeholder: string;
+    /**
+     * The amount to step up/down from the value when using the arrow keys
+     * defaults to `1`
+     */
     step: number;
+    /**
+     * The value of the input.
+     */
     value: number;
     autoWidth: boolean;
     moveFocusOnMax: boolean;
@@ -48,4 +88,3 @@ declare class NumberField extends Component<NumberFieldProps> {
     render(): JSX.Element;
 }
 export default NumberField;
-//# sourceMappingURL=NumberField.d.ts.map

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

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

package/dist/types/Pagination/Pagination.d.ts

@@ -1,12 +1,35 @@
 export declare type PaginationProps = {
+    /**
+     * Change the color of the active page
+     */
     activeColor?: string;
+    /**
+     * Accepts any valid [Button](/button) props.
+     */
     activePageLinkProps?: object;
+    /**
+     * Current visible page number
+     */
     currentPage: number;
+    /**
+     * Accepts any valid [Button](/button) props.
+     */
     navButtonProps?: object;
+    /**
+     * Callback when new page is requested
+     */
     onPageChange: (nextPage: number) => undefined;
+    /**
+     * Accepts any valid [Button](/button) props.
+     */
     pageLinkProps?: object;
+    /**
+     * Total available pages
+     */
     totalPages: number;
+    /**
+     * Amount of visible pages
+     */
     visiblePages?: number;
 };
 export default function Pagination({ currentPage, onPageChange, visiblePages, totalPages, ...restProps }: PaginationProps): JSX.Element;
-//# sourceMappingURL=Pagination.d.ts.map

package/dist/types/Popover/Popover.d.ts

@@ -1,32 +1,115 @@
 import * as React from 'react';
 export declare type PopoverProps = {
+    /**
+     * Controls the default component or tag being rendered.
+     */
     as?: any;
+    /**
+     * The element to attach the popover to. Clones the element's ref to calculate
+     * position relative to the optional `relativeTo` prop or the `renderTo` element.
+     */
     anchorElement: React.ReactElement | ((anchorCallbackProps: any) => null);
+    /**
+     * Attempts to keep popover in view clipping edges if too large.
+     */
     keepInView?: boolean;
+    /**
+     * Locks external scrollbars when open.
+     */
     lockScrollWhileOpen?: boolean;
+    /**
+     * Matches anchor and popover widths.
+     */
     matchWidths?: boolean | 'minimum';
+    /**
+     * Controls rendering of the popover.
+     */
     open: boolean;
+    /**
+     * Controls the space between the popover and its anchor.
+     */
     offset: number;
+    /**
+     * Called when the popover should close.
+     */
     onRequestClose?: () => void;
+    /**
+     * Where to place the popover.
+     */
     placement?: 'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end';
+    /**
+     * Where to place the popover relative to. Uses `renderTo` by default.
+     */
     relativeTo?: any;
+    /**
+     * Where to render the popover into. Accepts an HTML element or selector.
+     * Uses the closest fixed parent or `document.body` by default. This will only
+     * be computed once on initial render.
+     */
     renderTo?: HTMLElement | string;
+    /**
+     * Determines if the popover should flip or not when it overflows.
+     */
     shouldFlip?: boolean;
+    /**
+     * Calls `as` `innerRef` to calculate popover's bounds.
+     */
     innerRef?: any;
 } & React.HTMLAttributes<any>;
 export declare const Popover: React.ForwardRefExoticComponent<{
+    /**
+     * Controls the default component or tag being rendered.
+     */
     as?: any;
+    /**
+     * The element to attach the popover to. Clones the element's ref to calculate
+     * position relative to the optional `relativeTo` prop or the `renderTo` element.
+     */
     anchorElement: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any>) | (new (props: any) => React.Component<any, any, any>)> | ((anchorCallbackProps: any) => null);
+    /**
+     * Attempts to keep popover in view clipping edges if too large.
+     */
     keepInView?: boolean;
+    /**
+     * Locks external scrollbars when open.
+     */
     lockScrollWhileOpen?: boolean;
+    /**
+     * Matches anchor and popover widths.
+     */
     matchWidths?: boolean | 'minimum';
+    /**
+     * Controls rendering of the popover.
+     */
     open: boolean;
+    /**
+     * Controls the space between the popover and its anchor.
+     */
     offset: number;
+    /**
+     * Called when the popover should close.
+     */
     onRequestClose?: () => void;
+    /**
+     * Where to place the popover.
+     */
     placement?: 'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end';
+    /**
+     * Where to place the popover relative to. Uses `renderTo` by default.
+     */
     relativeTo?: any;
+    /**
+     * Where to render the popover into. Accepts an HTML element or selector.
+     * Uses the closest fixed parent or `document.body` by default. This will only
+     * be computed once on initial render.
+     */
     renderTo?: HTMLElement | string;
+    /**
+     * Determines if the popover should flip or not when it overflows.
+     */
     shouldFlip?: boolean;
+    /**
+     * Calls `as` `innerRef` to calculate popover's bounds.
+     */
     innerRef?: any;
 } & React.HTMLAttributes<any> & React.RefAttributes<unknown>>;
-//# sourceMappingURL=Popover.d.ts.map

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

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

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

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

package/dist/types/Popover/rewireTabOrder.d.ts

@@ -1,3 +1,2 @@
 declare const _default: (node: any) => () => void;
 export default _default;
-//# sourceMappingURL=rewireTabOrder.d.ts.map

package/dist/types/Popover/utils.d.ts

@@ -50,4 +50,3 @@ export declare function getModifiers({ matchWidths, offset, keepInView, shouldFl
     options?: undefined;
 })[];
 export declare function getFixedParent(node: any): any;
-//# sourceMappingURL=utils.d.ts.map

package/dist/types/Portal/Portal.d.ts

@@ -2,12 +2,18 @@ import * as React from 'react';
 import { Theme } from '../index';
 export declare type PortalProps = {
     children: any;
+    /** Styles to apply to the portal root element. */
     style?: React.CSSProperties;
+    /** Where the portal is rendered into. */
     renderTo?: HTMLElement | string;
+    /** The HTML element to create. Defaults to `div`. */
     renderTag?: string;
+    /** Callback when Portal is updated. */
     onUpdate?: () => void;
+    /** Returns the rendered node similar to refs. */
     getPortalNode?: (HTMLElement: any) => void;
 };
+/** Accepts any additional HTML attributes. */
 declare class Portal extends React.Component<PortalProps> {
     static defaultProps: {
         renderTag: string;
@@ -30,4 +36,3 @@ declare class Portal extends React.Component<PortalProps> {
     render(): number | React.ReactFragment | JSX.Element;
 }
 export { Portal };
-//# sourceMappingURL=Portal.d.ts.map

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

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

package/dist/types/Progress/Progress.d.ts

@@ -1,7 +1,12 @@
 export declare type Props = {
+    /**
+     * The current value of the progress bar.
+     */
     value?: number;
+    /**
+     * Active color of the progress bar.
+     */
     activeColor?: string;
 };
 declare const Progress: ({ value, ...restProps }: Props) => JSX.Element;
 export default Progress;
-//# sourceMappingURL=Progress.d.ts.map

package/dist/types/Radio/Radio.d.ts

@@ -1,16 +1,45 @@
 import React from 'react';
 export declare type RadioProps = {
+    /**
+     * Disables the radio component.
+     */
     disabled?: boolean;
+    /**
+     * Determines if the radio should use an internal label or not.
+     */
     label?: string;
+    /**
+     * Connects input to its corresponding label's `htmlFor`.
+     */
     id?: string | number;
+    /**
+     * Checks the radio.
+     */
     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 radio 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.FocusEvent<HTMLInputElement>) => void;
+    /**
+     * Maps to the internal input's `onBlur` prop.
+     */
     onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
 };
 declare const Radio: ({ checked, disabled, id, label, name, onBlur, onChange, onFocus, size, value, ...restProps }: RadioProps) => JSX.Element;
 export default Radio;
-//# sourceMappingURL=Radio.d.ts.map

package/dist/types/Scrim/Scrim.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
 declare type ScrimProps = {
+    /** Gain access to the internal ref. */
     ref?: any;
     children?: any;
 };
 declare const Scrim: React.ForwardRefExoticComponent<Pick<ScrimProps, "children"> & React.RefAttributes<unknown>>;
 export { Scrim };
-//# sourceMappingURL=Scrim.d.ts.map

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

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

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

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