@threekit-tools/treble 0.0.82 → 0.0.83

package/dist/components/Strips/index.d.ts

@@ -9,33 +9,11 @@ export interface IStrips extends IFormComponentProps<IOption> {
 export declare const Strips: {
     (props: IStrips): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<string>;
-        /**
-         * Handles the user seletion by passing the value of the selected
-         * option as the argument into the onClick callback.
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The options set to be displayed for the user
-         */
         options: PropTypes.Requireable<(PropTypes.InferProps<{
             name: PropTypes.Requireable<string>;
             description: PropTypes.Requireable<string>;
@@ -44,44 +22,12 @@ export declare const Strips: {
             color: PropTypes.Requireable<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-         * metadata key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-         */
         metadataKeyThumbnail: PropTypes.Requireable<string>;
-        /**
-         * By default the description is soruced from the `_description` metadata
-         * key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **metadataKeyDescription**
-         * prop.
-         */
         metadataKeyDescription: PropTypes.Requireable<string>;
-        /**
-         * By default the price of an item is soruced from the pricebook entry for
-         * the option's Catalog Item. The price can alternatively be soruced from
-         * the option's Catalog Item metadata, by specifying the key under which the
-         * price can be found as the **metadataKeyPrice** prop.
-         */
         metadataKeyPrice: PropTypes.Requireable<string>;
-        /**
-         * A boolean to set whether or all the Cards should display thumbnails
-         * for the options.
-         */
         showThumbnail: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the description
-         * for the options.
-         */
         showDescription: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the price
-         * for the options/
-         */
         showPrice: PropTypes.Requireable<boolean>;
     };
     defaultProps: {

package/dist/components/Strips/index.js

@@ -62,33 +62,11 @@ var Strips = function (props) {
 };
 exports.Strips = Strips;
 exports.Strips.propTypes = {
-    /**
-     * Is the attribute name on the initialized asset that we are
-     * using this component for. If the attribute prop is used,
-     * the component will ignore the props for: `value`, `options`, `onClick`.
-     */
     attribute: prop_types_1.default.string,
-    /**
-     * Used to add a title to the input
-     */
     title: prop_types_1.default.string,
-    /**
-     * Used to provide a custom description for the input component
-     */
     description: prop_types_1.default.string,
-    /**
-     * Selected value from the option set. Should match the 'value' property
-     * of one of the items in the options array.
-     */
     value: prop_types_1.default.string,
-    /**
-     * Handles the user seletion by passing the value of the selected
-     * option as the argument into the onClick callback.
-     */
     onClick: prop_types_1.default.func,
-    /**
-     * The options set to be displayed for the user
-     */
     options: prop_types_1.default.arrayOf(prop_types_1.default.shape({
         name: prop_types_1.default.string,
         description: prop_types_1.default.string,
@@ -97,59 +75,24 @@ exports.Strips.propTypes = {
         color: prop_types_1.default.string,
         disabled: prop_types_1.default.bool,
     })),
-    /**
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
-    /**
-     * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-     * metadata key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-     */
     metadataKeyThumbnail: prop_types_1.default.string,
-    /**
-     * By default the description is soruced from the `_description` metadata
-     * key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **metadataKeyDescription**
-     * prop.
-     */
     metadataKeyDescription: prop_types_1.default.string,
-    /**
-     * By default the price of an item is soruced from the pricebook entry for
-     * the option's Catalog Item. The price can alternatively be soruced from
-     * the option's Catalog Item metadata, by specifying the key under which the
-     * price can be found as the **metadataKeyPrice** prop.
-     */
     metadataKeyPrice: prop_types_1.default.string,
-    /**
-     * A boolean to set whether or all the Cards should display thumbnails
-     * for the options.
-     */
     showThumbnail: prop_types_1.default.bool,
-    /**
-     * A boolean to set whether or all the Cards should display the description
-     * for the options.
-     */
     showDescription: prop_types_1.default.bool,
-    /**
-     * A boolean to set whether or all the Cards should display the price
-     * for the options/
-     */
     showPrice: prop_types_1.default.bool,
 };
 exports.Strips.defaultProps = {
     description: undefined,
     className: undefined,
-    //  Default use
     attribute: undefined,
-    //  Default user overrides
     metadataKeyThumbnail: undefined,
     metadataKeyDescription: undefined,
     metadataKeyPrice: undefined,
     showThumbnail: true,
     showPrice: true,
     showDescription: true,
-    //  Custom use
     title: undefined,
     value: undefined,
     options: undefined,

package/dist/components/Swatch/index.d.ts

@@ -10,44 +10,13 @@ export interface ISwatch extends IFormComponentProps<IOption> {
 export declare const Swatch: {
     (props: ISwatch): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to set the shape of the Swatch Option component. Options
-         * include: `square`, `round`
-         */
         shape: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<string>;
-        /**
-         * Handles the user seletion by passing the value of the selected
-         * option as the argument into the onClick callback.
-         */
         size: PropTypes.Requireable<string>;
-        /**
-         * The size of the for a swatch option. The size should be a valid CSS
-         * height/width property.
-         *
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The options set to be displayed for the user
-         */
         options: PropTypes.Requireable<(PropTypes.InferProps<{
             name: PropTypes.Requireable<string>;
             description: PropTypes.Requireable<string>;
@@ -57,44 +26,12 @@ export declare const Swatch: {
             color: PropTypes.Requireable<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-         * metadata key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-         */
         metadataKeyThumbnail: PropTypes.Requireable<string>;
-        /**
-         * By default the description is soruced from the `_description` metadata
-         * key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **metadataKeyDescription**
-         * prop.
-         */
         metadataKeyDescription: PropTypes.Requireable<string>;
-        /**
-         * By default the price of an item is soruced from the pricebook entry for
-         * the option's Catalog Item. The price can alternatively be soruced from
-         * the option's Catalog Item metadata, by specifying the key under which the
-         * price can be found as the **metadataKeyPrice** prop.
-         */
         metadataKeyPrice: PropTypes.Requireable<string>;
-        /**
-         * A boolean to set whether or all the Cards should display thumbnails
-         * for the options.
-         */
         showThumbnail: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the description
-         * for the options.
-         */
         showDescription: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the price
-         * for the options/
-         */
         showPrice: PropTypes.Requireable<boolean>;
     };
     defaultProps: {

package/dist/components/Swatch/index.js

@@ -52,44 +52,13 @@ var Swatch = function (props) {
 };
 exports.Swatch = Swatch;
 exports.Swatch.propTypes = {
-    /**
-     * Is the attribute name on the initialized asset that we are
-     * using this component for. If the attribute prop is used,
-     * the component will ignore the props for: `value`, `options`, `onClick`.
-     */
     attribute: prop_types_1.default.string,
-    /**
-     * Used to set the shape of the Swatch Option component. Options
-     * include: `square`, `round`
-     */
     shape: prop_types_1.default.string,
-    /**
-     * Used to add a title to the input
-     */
     title: prop_types_1.default.string,
-    /**
-     * Used to provide a custom description for the input component
-     */
     description: prop_types_1.default.string,
-    /**
-     * Selected value from the option set. Should match the 'value' property
-     * of one of the items in the options array.
-     */
     value: prop_types_1.default.string,
-    /**
-     * Handles the user seletion by passing the value of the selected
-     * option as the argument into the onClick callback.
-     */
     size: prop_types_1.default.string,
-    /**
-     * The size of the for a swatch option. The size should be a valid CSS
-     * height/width property.
-     *
-     */
     onClick: prop_types_1.default.func,
-    /**
-     * The options set to be displayed for the user
-     */
     options: prop_types_1.default.arrayOf(prop_types_1.default.shape({
         name: prop_types_1.default.string,
         description: prop_types_1.default.string,
@@ -99,60 +68,25 @@ exports.Swatch.propTypes = {
         color: prop_types_1.default.string,
         disabled: prop_types_1.default.bool,
     })),
-    /**
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
-    /**
-     * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-     * metadata key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-     */
     metadataKeyThumbnail: prop_types_1.default.string,
-    /**
-     * By default the description is soruced from the `_description` metadata
-     * key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **metadataKeyDescription**
-     * prop.
-     */
     metadataKeyDescription: prop_types_1.default.string,
-    /**
-     * By default the price of an item is soruced from the pricebook entry for
-     * the option's Catalog Item. The price can alternatively be soruced from
-     * the option's Catalog Item metadata, by specifying the key under which the
-     * price can be found as the **metadataKeyPrice** prop.
-     */
     metadataKeyPrice: prop_types_1.default.string,
-    /**
-     * A boolean to set whether or all the Cards should display thumbnails
-     * for the options.
-     */
     showThumbnail: prop_types_1.default.bool,
-    /**
-     * A boolean to set whether or all the Cards should display the description
-     * for the options.
-     */
     showDescription: prop_types_1.default.bool,
-    /**
-     * A boolean to set whether or all the Cards should display the price
-     * for the options/
-     */
     showPrice: prop_types_1.default.bool,
 };
 exports.Swatch.defaultProps = {
     shape: 'round',
     description: undefined,
     className: undefined,
-    //  Default use
     attribute: undefined,
-    //  Default user overrides
     metadataKeyThumbnail: undefined,
     metadataKeyDescription: undefined,
     metadataKeyPrice: undefined,
     showThumbnail: true,
     showPrice: true,
     showDescription: true,
-    //  Custom use
     title: undefined,
     value: undefined,
     options: undefined,

package/dist/components/Switch/index.d.ts

@@ -7,46 +7,13 @@ export interface ISwitch extends IFormComponentProps<IOption> {
 export declare const Switch: {
     (props: ISwitch): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<boolean>;
-        /**
-         * The size of the for a Switch option. The size should be a valid CSS
-         * height/width property.
-         *
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * By default the description is soruced from the `_description` metadata
-         * key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **metadataKeyDescription**
-         * prop.
-         */
         metadataKeyDescription: PropTypes.Requireable<string>;
-        /**
-         * A boolean to set whether or all the Cards should display the description
-         * for the options.
-         */
         showDescription: PropTypes.Requireable<boolean>;
     };
     defaultProps: {

package/dist/components/Switch/index.js

@@ -26,57 +26,21 @@ var Switch = function (props) {
 };
 exports.Switch = Switch;
 exports.Switch.propTypes = {
-    /**
-     * Is the attribute name on the initialized asset that we are
-     * using this component for. If the attribute prop is used,
-     * the component will ignore the props for: `value`, `options`, `onClick`.
-     */
     attribute: prop_types_1.default.string,
-    /**
-     * Used to add a title to the input
-     */
     title: prop_types_1.default.string,
-    /**
-     * Used to provide a custom description for the input component
-     */
     description: prop_types_1.default.string,
-    /**
-     * Selected value from the option set. Should match the 'value' property
-     * of one of the items in the options array.
-     */
     value: prop_types_1.default.bool,
-    /**
-     * The size of the for a Switch option. The size should be a valid CSS
-     * height/width property.
-     *
-     */
     onClick: prop_types_1.default.func,
-    /**
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
-    /**
-     * By default the description is soruced from the `_description` metadata
-     * key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **metadataKeyDescription**
-     * prop.
-     */
     metadataKeyDescription: prop_types_1.default.string,
-    /**
-     * A boolean to set whether or all the Cards should display the description
-     * for the options.
-     */
     showDescription: prop_types_1.default.bool,
 };
 exports.Switch.defaultProps = {
     description: undefined,
     className: undefined,
-    //  Default use
     attribute: undefined,
-    //  Default user overrides
     metadataKeyDescription: undefined,
     showDescription: true,
-    //  Custom use
     title: undefined,
     value: undefined,
     onClick: undefined,

package/dist/components/TextInput/index.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TextInput = void 0;
 var react_1 = __importDefault(require("react"));
-// import PropTypes from 'prop-types';
 var FormComponentTitle_1 = __importDefault(require("../FormComponentTitle"));
 var FormComponentDescription_1 = __importDefault(require("../FormComponentDescription"));
 var textInput_styles_1 = require("./textInput.styles");

package/dist/components/Tiles/index.d.ts

@@ -7,46 +7,18 @@ export interface ITiles extends IFormComponentProps<IOptionShared> {
 export declare const Tiles: {
     (props: ITiles): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<string>;
-        /**
-         * Handles the user seletion by passing the value of the selected
-         * option as the argument into the onClick callback.
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The options set to be displayed for the user
-         */
         options: PropTypes.Requireable<(PropTypes.InferProps<{
             name: PropTypes.Requireable<string>;
             description: PropTypes.Requireable<string>;
             value: PropTypes.Requireable<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * Defines how many columns to organize the tiles into.
-         */
         columns: PropTypes.Requireable<number>;
     };
     defaultProps: {

package/dist/components/Tiles/index.js

@@ -28,55 +28,25 @@ var Tiles = function (props) {
 };
 exports.Tiles = Tiles;
 exports.Tiles.propTypes = {
-    /**
-     * Is the attribute name on the initialized asset that we are
-     * using this component for. If the attribute prop is used,
-     * the component will ignore the props for: `value`, `options`, `onClick`.
-     */
     attribute: prop_types_1.default.string,
-    /**
-     * Used to add a title to the input
-     */
     title: prop_types_1.default.string,
-    /**
-     * Used to provide a custom description for the input component
-     */
     description: prop_types_1.default.string,
-    /**
-     * Selected value from the option set. Should match the 'value' property
-     * of one of the items in the options array.
-     */
     value: prop_types_1.default.string,
-    /**
-     * Handles the user seletion by passing the value of the selected
-     * option as the argument into the onClick callback.
-     */
     onClick: prop_types_1.default.func,
-    /**
-     * The options set to be displayed for the user
-     */
     options: prop_types_1.default.arrayOf(prop_types_1.default.shape({
         name: prop_types_1.default.string,
         description: prop_types_1.default.string,
         value: prop_types_1.default.string,
         disabled: prop_types_1.default.bool,
     })),
-    /**
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
-    /**
-     * Defines how many columns to organize the tiles into.
-     */
     columns: prop_types_1.default.number,
 };
 exports.Tiles.defaultProps = {
     description: undefined,
     className: undefined,
     columns: 2,
-    //  Default use
     attribute: undefined,
-    //  Custom use
     title: undefined,
     value: undefined,
     options: undefined,

package/dist/components/TilesGroup/index.d.ts

@@ -7,42 +7,17 @@ export interface ITilesGroup extends IFormComponentProps<IOptionShared> {
 export declare const TilesGroup: {
     (props: ITilesGroup): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<string>;
-        /**
-         * Handles the user seletion by passing the value of the selected
-         * option as the argument into the onClick callback.
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The options set to be displayed for the user
-         */
         options: PropTypes.Requireable<(PropTypes.InferProps<{
             name: PropTypes.Requireable<string>;
             description: PropTypes.Requireable<string>;
             value: PropTypes.Requireable<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/TilesGroup/index.js

@@ -28,50 +28,23 @@ var TilesGroup = function (props) {
 };
 exports.TilesGroup = TilesGroup;
 exports.TilesGroup.propTypes = {
-    /**
-     * Is the attribute name on the initialized asset that we are
-     * using this component for. If the attribute prop is used,
-     * the component will ignore the props for: `value`, `options`, `onClick`.
-     */
     attribute: prop_types_1.default.string,
-    /**
-     * Used to add a title to the input
-     */
     title: prop_types_1.default.string,
-    /**
-     * Used to provide a custom description for the input component
-     */
     description: prop_types_1.default.string,
-    /**
-     * Selected value from the option set. Should match the 'value' property
-     * of one of the items in the options array.
-     */
     value: prop_types_1.default.string,
-    /**
-     * Handles the user seletion by passing the value of the selected
-     * option as the argument into the onClick callback.
-     */
     onClick: prop_types_1.default.func,
-    /**
-     * The options set to be displayed for the user
-     */
     options: prop_types_1.default.arrayOf(prop_types_1.default.shape({
         name: prop_types_1.default.string,
         description: prop_types_1.default.string,
         value: prop_types_1.default.string,
         disabled: prop_types_1.default.bool,
     })),
-    /**
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
 };
 exports.TilesGroup.defaultProps = {
     description: undefined,
     className: undefined,
-    //  Default use
     attribute: undefined,
-    //  Custom use
     title: undefined,
     value: undefined,
     options: undefined,