@threekit-tools/treble 0.0.82 → 0.0.83

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

@@ -9,33 +9,11 @@ export interface ICards extends IFormComponentProps<IOption> {
 export declare const Cards: {
     (props: ICards): 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>;
@@ -45,44 +23,12 @@ export declare const Cards: {
             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/Cards/index.js

@@ -62,33 +62,11 @@ var Cards = function (props) {
 };
 exports.Cards = Cards;
 exports.Cards.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,
@@ -98,59 +76,24 @@ exports.Cards.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.Cards.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/Drawer/index.js

@@ -72,22 +72,9 @@ var Drawer = function (props) {
 };
 exports.Drawer = Drawer;
 exports.Drawer.propTypes = {
-    /**
-     * The title to be shown in the Drawer header
-     */
     title: prop_types_1.default.string,
-    /**
-     * Callback function to close the Drawer. Can be used with custom UI
-     * components in the Drawer
-     */
     handleClose: prop_types_1.default.func,
-    /**
-     * Whether or not to render the default Drawer header
-     */
     showHeader: 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.Drawer.defaultProps = {

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

@@ -10,33 +10,11 @@ export interface IDropdown extends IFormComponentProps<IOption> {
 export declare const Dropdown: {
     (props: IDropdown): 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>;
@@ -46,49 +24,13 @@ export declare const Dropdown: {
             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>;
-        /**
-         * The maximum height the dropdown area should extend to before scrolling
-         * is introduced
-         */
         dropdownMaxHeight: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/Dropdown/index.js

@@ -82,11 +82,7 @@ var Dropdown = function (props) {
     return (react_1.default.createElement("div", { className: cls },
         react_1.default.createElement(FormComponentTitle_1.default, { title: title, className: cls }),
         react_1.default.createElement(FormComponentDescription_1.default, { description: description, className: cls }),
-        react_1.default.createElement(dropdown_styles_1.DropdownWrapper
-        // active={!hide}
-        , { 
-            // active={!hide}
-            ref: ref, className: "".concat(cls, " dropdown") },
+        react_1.default.createElement(dropdown_styles_1.DropdownWrapper, { ref: ref, className: "".concat(cls, " dropdown") },
             react_1.default.createElement(dropdown_styles_1.DropdownMain, { active: !hide, className: "".concat(cls, " selected"), onClick: function () { return setHide(!hide); }, hasPlaceholder: !value },
                 react_1.default.createElement(Thumbnail, { imageUrl: selectedOpt === null || selectedOpt === void 0 ? void 0 : selectedOpt.imageUrl, color: selectedOpt === null || selectedOpt === void 0 ? void 0 : selectedOpt.color, name: selectedOpt === null || selectedOpt === void 0 ? void 0 : selectedOpt.name, className: "".concat(cls, " selected") }),
                 react_1.default.createElement("div", null,
@@ -118,33 +114,11 @@ var Dropdown = function (props) {
 };
 exports.Dropdown = Dropdown;
 exports.Dropdown.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,
@@ -154,64 +128,25 @@ exports.Dropdown.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,
-    /**
-     * The maximum height the dropdown area should extend to before scrolling
-     * is introduced
-     */
     dropdownMaxHeight: prop_types_1.default.string,
 };
 exports.Dropdown.defaultProps = {
     description: undefined,
     className: undefined,
-    //  Default use
     attribute: undefined,
-    //  Default user overrides
     metadataKeyThumbnail: '_thumbnail',
     metadataKeyDescription: undefined,
     metadataKeyPrice: undefined,
     showThumbnail: true,
     showPrice: true,
     showDescription: true,
-    //  Custom use
     value: undefined,
     options: undefined,
     onClick: undefined,

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

@@ -12,36 +12,15 @@ interface FlatFormProps {
 export declare const FlatForm: {
     (props: FlatFormProps): JSX.Element | null;
     propTypes: {
-        /**
-         * Used to add a title to Form (defaults to the intialized Catalog Item's name)
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Alignement for the title. Options include `left`, `center` or `right`
-         */
         alignTitle: PropTypes.Requireable<string>;
-        /**
-         * Used to add a description to Form
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * The attributes prop allows us to specify which components to use for
-         * our attributes and what props we want to pass into their components.
-         *
-         * The attributes prop takes and object with the keys matching the name
-         * of the attribute you wish to target and value as an object includeing
-         * the component to use and props to pass in.
-         */
         attributes: PropTypes.Requireable<{
             [x: string]: PropTypes.InferProps<{
                 component: PropTypes.Requireable<string>;
                 props: PropTypes.Requireable<object>;
             }> | null | undefined;
         }>;
-        /**
-         *
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/FlatForm/index.js

@@ -93,34 +93,13 @@ var FlatForm = function (props) {
 };
 exports.FlatForm = FlatForm;
 exports.FlatForm.propTypes = {
-    /**
-     * Used to add a title to Form (defaults to the intialized Catalog Item's name)
-     */
     title: prop_types_1.default.string,
-    /**
-     * Alignement for the title. Options include `left`, `center` or `right`
-     */
     alignTitle: prop_types_1.default.string,
-    /**
-     * Used to add a description to Form
-     */
     description: prop_types_1.default.string,
-    /**
-     * The attributes prop allows us to specify which components to use for
-     * our attributes and what props we want to pass into their components.
-     *
-     * The attributes prop takes and object with the keys matching the name
-     * of the attribute you wish to target and value as an object includeing
-     * the component to use and props to pass in.
-     */
     attributes: prop_types_1.default.objectOf(prop_types_1.default.shape({
         component: prop_types_1.default.string,
         props: prop_types_1.default.object,
     })),
-    /**
-     *
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
 };
 exports.FlatForm.defaultProps = {

package/dist/components/Modal/index.js

@@ -39,22 +39,9 @@ var Modal = function (props) {
 };
 exports.Modal = Modal;
 exports.ModalComponent.propTypes = {
-    /**
-     * The title to be shown in the Modal header
-     */
     title: prop_types_1.default.string,
-    /**
-     * Callback function to close the modal. Can be used with custom UI
-     * components in the Modal
-     */
     handleClose: prop_types_1.default.func,
-    /**
-     * Whether or not to render the default Modal header
-     */
     showHeader: 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.ModalComponent.defaultProps = {

package/dist/components/PortalToElement/index.js

@@ -24,15 +24,7 @@ var PortalToElement = function (props) {
 };
 exports.PortalToElement = PortalToElement;
 exports.PortalToElement.propTypes = {
-    /**
-     * The id of the HTML element you want the content to be rendered in
-     */
     to: prop_types_1.default.string,
-    /**
-     * Defines the behaviour if the HTML element is not found. If strict is
-     * set to `true` the content will not render, if set to `false` the
-     * content will render out in its defualt flow.
-     */
     strict: prop_types_1.default.bool,
 };
 exports.PortalToElement.defaultProps = {};

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

@@ -7,13 +7,7 @@ interface IProductDescription {
 export declare const ProductDescriptionComponent: {
     (props: IProductDescription): JSX.Element;
     propTypes: {
-        /**
-         * The description displayed to the user
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Custom classNames applied to the HTML Element to apply custom CSS styling.
-         */
         className: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/ProductDescription/index.js

@@ -28,13 +28,7 @@ var ProductDescription = function (props) {
     return (react_1.default.createElement(exports.ProductDescriptionComponent, { className: className, description: ((_a = metadata === null || metadata === void 0 ? void 0 : metadata._description) === null || _a === void 0 ? void 0 : _a.toString()) || description }));
 };
 exports.ProductDescriptionComponent.propTypes = {
-    /**
-     * The description displayed to the user
-     */
     description: prop_types_1.default.string,
-    /**
-     * Custom classNames applied to the HTML Element to apply custom CSS styling.
-     */
     className: prop_types_1.default.string,
 };
 exports.ProductDescriptionComponent.defaultProps = {

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

@@ -8,17 +8,8 @@ interface ITitle {
 export declare const ProductNameComponent: {
     (props: ITitle): JSX.Element;
     propTypes: {
-        /**
-         * The title displayed to the user
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Custom classNames applied to the HTML Element to apply custom CSS styling.
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * The CSS Text alignment property. Options: 'left' | 'center' | 'right'
-         */
         align: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/ProductName/index.js

@@ -24,17 +24,8 @@ var ProductName = function (props) {
 };
 exports.ProductName = ProductName;
 exports.ProductNameComponent.propTypes = {
-    /**
-     * The title displayed to the user
-     */
     title: prop_types_1.default.string,
-    /**
-     * Custom classNames applied to the HTML Element to apply custom CSS styling.
-     */
     className: prop_types_1.default.string,
-    /**
-     * The CSS Text alignment property. Options: 'left' | 'center' | 'right'
-     */
     align: prop_types_1.default.string,
 };
 exports.ProductNameComponent.defaultProps = {

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

@@ -11,20 +11,8 @@ export declare const Share: {
     (props: ShareProps): JSX.Element | null;
     propTypes: {
         className: PropTypes.Requireable<string>;
-        /**
-         * The presentational type of the input component. Options
-         * include: `hollow`, `standard`, `accent`, `primary`
-         */
         type: PropTypes.Requireable<string>;
-        /**
-         * Used to set the shape of the Widget button. Options
-         * include: `square`, `round`
-         */
         shape: PropTypes.Requireable<string>;
-        /**
-         * Used to set an overwrite of the message presented to the user
-         * when the share URL has been successfully copied.
-         */
         message: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/Share/index.js

@@ -26,20 +26,8 @@ var Share = function (props) {
 exports.Share = Share;
 exports.Share.propTypes = {
     className: prop_types_1.default.string,
-    /**
-     * The presentational type of the input component. Options
-     * include: `hollow`, `standard`, `accent`, `primary`
-     */
     type: prop_types_1.default.string,
-    /**
-     * Used to set the shape of the Widget button. Options
-     * include: `square`, `round`
-     */
     shape: prop_types_1.default.string,
-    /**
-     * Used to set an overwrite of the message presented to the user
-     * when the share URL has been successfully copied.
-     */
     message: prop_types_1.default.string,
 };
 exports.Share.defaultProps = {

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

@@ -13,15 +13,7 @@ export declare const Snapshots: {
     (props: SnapshotProps): JSX.Element | null;
     propTypes: {
         className: PropTypes.Requireable<string>;
-        /**
-         * The presentational type of the input component. Options
-         * include: `hollow`, `standard`, `accent`, `primary`
-         */
         type: PropTypes.Requireable<string>;
-        /**
-         * Used to set the shape of the Widget button. Options
-         * include: `square`, `round`
-         */
         shape: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/Snapshots/index.js

@@ -24,15 +24,7 @@ var Snapshots = function (props) {
 exports.Snapshots = Snapshots;
 exports.Snapshots.propTypes = {
     className: prop_types_1.default.string,
-    /**
-     * The presentational type of the input component. Options
-     * include: `hollow`, `standard`, `accent`, `primary`
-     */
     type: prop_types_1.default.string,
-    /**
-     * Used to set the shape of the Widget button. Options
-     * include: `square`, `round`
-     */
     shape: prop_types_1.default.string,
 };
 exports.Snapshots.defaultProps = {