@usecapsule/core-components 3.2.0-dev.0 → 3.2.0

package/dist/types/components/cpsl-col/cpsl-col.d.ts

@@ -1,27 +1,123 @@
 export declare class CpslCol {
+    /**
+     * The amount to offset the column, in terms of how many columns it should shift to the end
+     * of the total available.
+     */
     offset?: string;
+    /**
+     * The amount to offset the column for xs screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     offsetXs?: string;
+    /**
+     * The amount to offset the column for sm screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     offsetSm?: string;
+    /**
+     * The amount to offset the column for md screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     offsetMd?: string;
+    /**
+     * The amount to offset the column for lg screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     offsetLg?: string;
+    /**
+     * The amount to offset the column for xl screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     offsetXl?: string;
+    /**
+     * The amount to pull the column, in terms of how many columns it should shift to the start of
+     * the total available.
+     */
     pull?: string;
+    /**
+     * The amount to pull the column for xs screens, in terms of how many columns it should shift
+     * to the start of the total available.
+     */
     pullXs?: string;
+    /**
+     * The amount to pull the column for sm screens, in terms of how many columns it should shift
+     * to the start of the total available.
+     */
     pullSm?: string;
+    /**
+     * The amount to pull the column for md screens, in terms of how many columns it should shift
+     * to the start of the total available.
+     */
     pullMd?: string;
+    /**
+     * The amount to pull the column for lg screens, in terms of how many columns it should shift
+     * to the start of the total available.
+     */
     pullLg?: string;
+    /**
+     * The amount to pull the column for xl screens, in terms of how many columns it should shift
+     * to the start of the total available.
+     */
     pullXl?: string;
+    /**
+     * The amount to push the column, in terms of how many columns it should shift to the end
+     * of the total available.
+     */
     push?: string;
+    /**
+     * The amount to push the column for xs screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     pushXs?: string;
+    /**
+     * The amount to push the column for sm screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     pushSm?: string;
+    /**
+     * The amount to push the column for md screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     pushMd?: string;
+    /**
+     * The amount to push the column for lg screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     pushLg?: string;
+    /**
+     * The amount to push the column for xl screens, in terms of how many columns it should shift
+     * to the end of the total available.
+     */
     pushXl?: string;
+    /**
+     * The size of the column, in terms of how many columns it should take up out of the total
+     * available. If `"auto"` is passed, the column will be the size of its content.
+     */
     size?: string;
+    /**
+     * The size of the column for xs screens, in terms of how many columns it should take up out
+     * of the total available. If `"auto"` is passed, the column will be the size of its content.
+     */
     sizeXs?: string;
+    /**
+     * The size of the column for sm screens, in terms of how many columns it should take up out
+     * of the total available. If `"auto"` is passed, the column will be the size of its content.
+     */
     sizeSm?: string;
+    /**
+     * The size of the column for md screens, in terms of how many columns it should take up out
+     * of the total available. If `"auto"` is passed, the column will be the size of its content.
+     */
     sizeMd?: string;
+    /**
+     * The size of the column for lg screens, in terms of how many columns it should take up out
+     * of the total available. If `"auto"` is passed, the column will be the size of its content.
+     */
     sizeLg?: string;
+    /**
+     * The size of the column for xl screens, in terms of how many columns it should take up out
+     * of the total available. If `"auto"` is passed, the column will be the size of its content.
+     */
     sizeXl?: string;
     onResize(): void;
     private getColumns;

package/dist/types/components/cpsl-drawer/cpsl-drawer.d.ts

@@ -2,14 +2,45 @@ export declare class CpslDrawer {
     el: HTMLCpslDrawerElement;
     closedAnchorPosition?: string;
     showTransition: boolean;
+    /**
+     * Side from which the drawer will enter from.
+     */
     anchor: 'top' | 'bottom' | 'left' | 'right';
+    /**
+     * Starting anchor position.
+     */
     anchorPosition?: number;
+    /**
+     * Hides the overlay for temporary drawers.
+     */
     noOverlay?: boolean;
+    /**
+     * Whether the drawer is open or not.
+     */
     open: boolean;
+    /**
+     * Size (height or width) of the drawer.
+     */
     size: number | 'auto';
+    /**
+     * Duration in seconds of the open/close animation.
+     * Default is 0.15.
+     */
     transitionDuration?: number;
+    /**
+     * Transition timing function to use.
+     * Default is ease-in-out.
+     */
     transitionFunction?: string;
+    /**
+     * The variant of the drawer.
+     * `temporary` drawers will cover content and contain a backdrop. `permanent` drawers will sit beside content, i.e. desktop navigation.
+     * Default is `temporary`.
+     */
     variant?: 'temporary' | 'permanent';
+    /**
+     * Override z-index.
+     */
     zIndexOverride?: number;
     componentDidLoad(): void;
     private getContainerHeight;

package/dist/types/components/cpsl-dropdown/cpsl-dropdown.d.ts

@@ -2,13 +2,28 @@ import { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
 import { DropdownInputEventDetail } from './dropdown-interface';
 export declare class CpslDropdown implements ComponentInterface {
     el: HTMLCpslDropdownElement;
+    /**
+     * Width of the dropdown
+     */
     width: string;
+    /**
+     * Whether or not to include search capability
+     */
     hasCpslSearch: boolean;
     isOpen: boolean;
     searchQuery: string;
     filteredItems: Array<DropdownInputEventDetail>;
+    /**
+     * Items to be presented in the dropdown
+     */
     items: Array<DropdownInputEventDetail>;
+    /**
+     * The selected item in the dropdown
+     */
     selectedItem?: DropdownInputEventDetail | null;
+    /**
+     * Event emitted when the selected item changes
+     */
     selectedItemChange: EventEmitter<DropdownInputEventDetail>;
     handleSelectedItemChange(newValue: DropdownInputEventDetail | null): void;
     private toggleDropdown;

package/dist/types/components/cpsl-dropdown/dropdown-interface.d.ts

@@ -1,4 +1,4 @@
-import { IconType } from "../../interface";
+import { IconType } from '../../interface';
 export interface DropdownInputEventDetail {
     icon: IconType;
     label: string;

package/dist/types/components/cpsl-file-upload/cpsl-file-upload.d.ts

@@ -7,19 +7,62 @@ export declare class CpslFileUpload {
     dragError?: boolean;
     isUploading?: boolean;
     uploadError?: boolean;
+    /**
+     * Error text to show below the input. If this is provided the input will enter an error state.
+     */
     errorText?: string;
+    /**
+     * Filename for the external source of the selected file.
+     */
     externalFilename?: string;
+    /**
+     * External source for the selected file.
+     */
     externalSrc?: string;
+    /**
+     * Valid file types.
+     */
     fileTypes?: string[];
+    /**
+     * Helper text to show below the input. If `"errorText"` is provided that will take precedence.
+     */
     helperText?: string;
+    /**
+     * The label for the input.
+     */
     label?: string;
+    /**
+     * If `true`, the user must fill in a value before submitting a form.
+     */
     required: boolean;
+    /**
+     * If `true`, the label will display an "optional" tag.
+     */
     showOptionalLabel: boolean;
+    /**
+     * Function to trigger file upload to server.
+     * Returns: boolean indicating success or failure.
+     */
     uploadFile?: (file: File) => Promise<boolean>;
+    /**
+     * Emitted when the file is dropped in the input.
+     */
     cpslOnDrop: EventEmitter<DragEvent>;
+    /**
+     * Emitted when the file drag enters the input.
+     */
     cpslOnDragEnter: EventEmitter<DragEvent>;
+    /**
+     * Emitted when the file drag leaves the input.
+     */
     cpslOnDragLeave: EventEmitter<DragEvent>;
+    /**
+     * Emitted when the file changes.
+     */
     cpslFileChange: EventEmitter<File>;
+    /**
+     * Emitted when the file is removed.
+     */
     cpslFileRemoved: EventEmitter<void>;
     private handleDrop;
     private handleDragEnter;

package/dist/types/components/cpsl-grid/cpsl-grid.d.ts

@@ -1,4 +1,7 @@
 export declare class CpslGrid {
+    /**
+     * If `true`, the grid will have a fixed width based on the screen size.
+     */
     fixed: boolean;
     render(): any;
 }

package/dist/types/components/cpsl-hero/cpsl-hero.d.ts

@@ -1,4 +1,11 @@
 export declare class CpslHero {
+    /**
+     * The variant of the button.
+     * Options are: `"default"`, `"loading", `"success".
+     * Default is: `"default"`.
+     */
     variant?: 'connection' | 'pending' | 'approved' | 'failed';
+    title: string;
+    subtitle?: string;
     render(): any;
 }

package/dist/types/components/cpsl-icon/cpsl-icon.d.ts

@@ -1,6 +1,12 @@
 import { IconType } from '../../interface';
 export declare class CpslIcon {
+    /**
+     * The external source of the icon. If both `icon` and `src` are provided, `icon` will be used.
+     */
     src?: string;
+    /**
+     * The name of the icon. If both `icon` and `src` are provided, `icon` will be used.
+     */
     icon?: IconType;
     render(): any;
 }

package/dist/types/components/cpsl-identicon/cpsl-identicon.d.ts

@@ -1,5 +1,9 @@
 export declare class CpslIdenticon {
     hash: string;
+    /**
+     *  The size of the identicon.
+     *  Default is: 40.
+     */
     size: number;
     render(): any;
 }

package/dist/types/components/cpsl-input/cpsl-input.d.ts

@@ -5,47 +5,185 @@ export declare class CpslInput {
     private nativeInput?;
     el: HTMLCpslInputElement;
     private inputId;
+    /**
+     * The value of the input when the input is focused.
+     */
     private focusedValue?;
     hasFocus: boolean;
+    /**
+     * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.
+     * Available options: `"off"`, `"none"`, `"on"`, `"sentences"`, `"words"`, `"characters"`.
+     */
     autocapitalize: string;
+    /**
+     * Indicates whether the value of the control can be automatically completed by the browser.
+     */
     autocomplete: AutocompleteTypes;
+    /**
+     * Whether auto correction should be enabled when the user is entering/editing the text value.
+     */
     autocorrect: 'on' | 'off';
+    /**
+     * Whether to disable auto disabling of the slotted components.
+     */
     noAutoDisable: boolean;
+    /**
+     * Sets the [`autofocus` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus) on the native input element.
+     *
+     * This may not be sufficient for the element to be focused on page load.
+     */
     autofocus: boolean;
+    /**
+     * If `true`, the user cannot interact with the input.
+     */
     disabled: boolean;
+    /**
+     * A hint to the browser for which enter key to display.
+     * Possible values: `"enter"`, `"done"`, `"go"`, `"next"`,
+     * `"previous"`, `"search"`, and `"send"`.
+     */
     enterkeyhint?: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
+    /**
+     * Error text to show below the input. If this is provided the input will enter an error state.
+     */
     errorText?: string;
+    /**
+     * Helper text to show below the input. If `"errorText"` is provided that will take precedence.
+     */
     helperText?: string;
+    /**
+     * A hint to the browser for which keyboard to display.
+     * Possible values: `"none"`, `"text"`, `"tel"`, `"url"`,
+     * `"email"`, `"numeric"`, `"decimal"`, and `"search"`.
+     */
     inputmode?: 'none' | 'text' | 'tel' | 'url' | 'email' | 'numeric' | 'decimal' | 'search';
+    /**
+     * The label for the input.
+     */
     label?: string;
+    /**
+     * The maximum value, which must not be less than its minimum (min attribute) value.
+     */
     max?: string | number;
+    /**
+     * If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter.
+     */
     maxlength?: number;
+    /**
+     * The minimum value, which must not be greater than its maximum (max attribute) value.
+     */
     min?: string | number;
+    /**
+     * If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter.
+     */
     minlength?: number;
+    /**
+     * If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `"email"`, otherwise it is ignored.
+     */
     multiple?: boolean;
+    /**
+     * The name of the control, which is submitted with the form data.
+     */
     name: string;
+    /**
+     * A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, `"date"`, or `"password"`, otherwise it is ignored. When the type attribute is `"date"`, `pattern` will only be used in browsers that do not support the `"date"` input type natively. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date for more information.
+     */
     pattern?: string;
+    /**
+     * Instructional text that shows before the input has a value.
+     * This property applies only when the `type` property is set to `"email"`,
+     * `"number"`, `"password"`, `"search"`, `"tel"`, `"text"`, or `"url"`, otherwise it is ignored.
+     */
     placeholder?: string;
+    /**
+     * If `true`, the user cannot modify the value.
+     */
     readonly: boolean;
+    /**
+     * If `true`, the user must fill in a value before submitting a form.
+     */
     required: boolean;
+    /**
+     * If `true`, the label will display an "optional" tag.
+     */
     showOptionalLabel: boolean;
+    /**
+     * If `true`, the element will have its spelling and grammar checked.
+     */
     spellcheck: boolean;
+    /**
+     * The external source of the icon at the start of the input. If both `startIcon` and `startIconSrc` are provided, `startIcon` will be used.
+     */
     startIconSrc?: string;
+    /**
+     * The name of the icon at the start of the input. If both `startIcon` and `startIconSrc` are provided, `startIcon` will be used.
+     */
     startIcon?: IconType;
+    /**
+     * Works with the min and max attributes to limit the increments at which a value can be set.
+     * Possible values are: `"any"` or a positive floating point number.
+     */
     step?: string;
+    /**
+     * The type of control to display. The default type is `text`.
+     */
     type: TextFieldTypes;
+    /**
+     * The value of the controlled input.
+     */
     value?: string;
+    /**
+     * The `cpslInput` event is fired each time the user modifies the input's value.
+     * Unlike the `cpslChange` event, the `cpslInput` event is fired for each alteration
+     * to the input's value. This typically happens for each keystroke as the user types.
+     *
+     * For elements that accept text input (`type=text`, `type=tel`, etc.), the interface
+     * is [`InputEvent`](https://developer.mozilla.org/en-US/docs/Web/API/InputEvent); for others,
+     * the interface is [`Event`](https://developer.mozilla.org/en-US/docs/Web/API/Event). If
+     * the input is cleared on edit, the type is `null`.
+     */
     cpslInput: EventEmitter<InputInputEventDetail>;
+    /**
+     * The `cpslChange` event is fired when the user modifies the input's value.
+     * Unlike the `cpslInput` event, the `cpslChange` event is only fired when changes
+     * are committed, not as the user types.
+     *
+     * Depending on the way the users interacts with the element, the `cpslChange`
+     * event fires at a different moment:
+     * - When the element loses focus after its value has changed: for elements
+     * where the user's interaction is typing.
+     */
     cpslChange: EventEmitter<InputChangeEventDetail>;
+    /**
+     * Emitted when the input loses focus.
+     */
     cpslBlur: EventEmitter<FocusEvent>;
+    /**
+     * Emitted when the input has focus.
+     */
     cpslFocus: EventEmitter<FocusEvent>;
+    /**
+     * Emitted when something has been paste into the input.
+     */
     cpslPaste: EventEmitter<ClipboardEvent>;
     handleDisable(): void;
+    /**
+     * Update the native input element when the value changes
+     */
     componentDidLoad(): void;
     private disableSlots;
     private enableSlots;
     private initButtons;
+    /**
+     * Emits a `cpslInput` event.
+     */
     private emitInputChange;
+    /**
+     * Emits a `cpslChange` event.
+     *
+     * This API should be called for user committed changes.
+     * This API should not be used for external value changes.
+     */
     private emitValueChange;
     private onInput;
     private onChange;

package/dist/types/components/cpsl-input/input-interface.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Values are converted to strings when emitted which is
+ * why we do not have a `number` type here even though the
+ * `value` prop accepts a `number` type.
+ */
 export interface InputChangeEventDetail {
     value?: string | null;
     event?: Event;

package/dist/types/components/cpsl-modal/cpsl-modal.d.ts

@@ -5,17 +5,56 @@ export declare class CpslModal {
     private hasAnimatedIn;
     el: HTMLCpslModalElement;
     hasFooter: boolean;
+    /**
+     * Duration in seconds of the modal entering.
+     * Default is .15.
+     */
     enterTransitionDuration?: number;
+    /**
+     * Duration in seconds of the modal exiting.
+     * Default is .15.
+     */
     exitTransitionDuration?: number;
+    /**
+     * Whether or not to show `footerExpandedFooter` and `footerExpandedHeader` slots.
+     */
     footerExpanded?: boolean;
+    /**
+     * Duration in seconds of the footer expansion animation.
+     * Default is 0.15.
+     */
     footerTransitionDuration?: number;
+    /**
+     * Whether or not to show the overlay. This will always show the modal, regardless of the value of `open`.
+     */
     noOverlay?: boolean;
+    /**
+     * Whether or not to show the modal.
+     */
     open: boolean;
+    /**
+     * Emitted when enter animation starts.
+     */
     cpslModalEntering: EventEmitter<null>;
+    /**
+     * Emitted when enter animation finishes.
+     */
     cpslModalEntered: EventEmitter<null>;
+    /**
+     * Emitted when exit animation starts.
+     */
     cpslModalExiting: EventEmitter<null>;
+    /**
+     * Emitted when exit animation finishes.
+     */
     cpslModalExited: EventEmitter<null>;
+    /**
+     * Emitted when exit animation finishes.
+     */
     cpslModalRequestClose: EventEmitter<null>;
+    /**
+     * Override z-index.
+     */
     zIndexOverride?: number;
     toggleHeight(): void;
     toggleModal(): void;

package/dist/types/components/cpsl-modal-v2/cpsl-modal-v2.d.ts

@@ -1,15 +1,47 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 export declare class CpslModalV2 {
     el: HTMLCpslModalV2Element;
+    /**
+     * Duration in seconds of the modal entering.
+     * Default is .15.
+     */
     enterTransitionDuration?: number;
+    /**
+     * Duration in seconds of the modal exiting.
+     * Default is .15.
+     */
     exitTransitionDuration?: number;
+    /**
+     * Whether or not to show the modal with a box shadow.
+     */
     elevated: boolean;
+    /**
+     * Whether or not to show the overlay.
+     */
     noOverlay: boolean;
+    /**
+     * Whether or not to show the modal.
+     */
     open: boolean;
+    /**
+     * Override z-index.
+     */
     zIndexOverride?: number;
+    /**
+     * Emitted when enter animation starts.
+     */
     cpslModalEntering: EventEmitter<null>;
+    /**
+     * Emitted when enter animation finishes.
+     */
     cpslModalEntered: EventEmitter<null>;
+    /**
+     * Emitted when exit animation starts.
+     */
     cpslModalExiting: EventEmitter<null>;
+    /**
+     * Emitted when exit animation finishes.
+     */
     cpslModalExited: EventEmitter<null>;
     toggleHeight(): void;
     componentDidLoad(): void;

package/dist/types/components/cpsl-nav-button-group/cpsl-nav-button-group.d.ts

@@ -1,5 +1,8 @@
 export declare class CpslNavButtonGroup {
     el: HTMLCpslNavButtonGroupElement;
+    /**
+     * The id of the selected button.
+     */
     selectedId?: string;
     selectItem(): void;
     componentWillRender(): void;

package/dist/types/components/cpsl-overlay/cpsl-overlay.d.ts

@@ -1,8 +1,22 @@
 export declare class CpslOverlay {
     el: HTMLCpslOverlayElement;
+    /**
+     * Duration in seconds of the fade out animation.
+     * Default is .5.
+     */
     enterTransitionDuration?: number;
+    /**
+     * Duration in seconds of the fade out animation.
+     * Default is .5.
+     */
     exitTransitionDuration?: number;
+    /**
+     * Whether or not to show the overlay.
+     */
     open: boolean;
+    /**
+     * Override z-index.
+     */
     zIndexOverride?: number;
     toggleHeight(): void;
     componentDidLoad(): void;

package/dist/types/components/cpsl-pagination/cpsl-pagination.d.ts

@@ -1,9 +1,24 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 export declare class CpslPagination {
     currentPage: number;
+    /**
+     * The initial page to select.
+     * Default is 0.
+     */
     initialPage?: number;
+    /**
+     * The total number of pages.
+     */
     totalPages: number;
+    /**
+     * The number of pages visible to select.
+     * Default is 5.
+     * Min is 5.
+     */
     visiblePages?: number;
+    /**
+     * Emitted when exit animation finishes.
+     */
     cpslPaginationChanged: EventEmitter<number>;
     watchChange(): void;
     componentWillLoad(): void;

package/dist/types/components/cpsl-pill/cpsl-pill.d.ts

@@ -1,4 +1,7 @@
 export declare class CpslPill {
+    /**
+     * Text of the pill.
+     */
     text: string;
     render(): any;
 }