@carbon/ibm-products-web-components/custom-elements.json

Carbon for IBM Products Web Components

{
  "version": "experimental",
  "tags": [
    {
      "name": "c4p-about-modal",
      "path": "./src/components/about-modal/about-modal.ts",
      "description": "About Modal.",
      "attributes": [
        {
          "name": "open",
          "description": "Determines if About Modal is open or not.",
          "type": "boolean",
          "default": "true"
        },
        {
          "name": "closeIconDescription",
          "description": "Determines if About Modal is open or not.",
          "type": "string",
          "default": "\"close\""
        },
        {
          "name": "copyrightText",
          "description": "Determines if About Modal is open or not."
        },
        {
          "name": "logo",
          "description": "A visual symbol used to represent the product."
        },
        {
          "name": "version",
          "description": "Text that provides information on the version number of your product."
        },
        {
          "name": "title",
          "description": "Header text that provides the product name. The IBM Services logo consists of two discrete, but required, elements: the iconic IBM 8-bar logo represented alongside the IBM Services logotype. Please follow these guidelines to ensure proper execution."
        },
        {
          "name": "additionalInfo",
          "description": "If you are legally required to display logos of technologies used to build your product you can provide this in the additionalInfo. Additional information will be displayed in the footer."
        },
        {
          "name": "content",
          "description": "Subhead text providing any relevant product disclaimers including legal information (optional)"
        },
        {
          "name": "links",
          "description": "An array of Carbon `Link` component if there are additional information to call out within the card. The about modal should be used to display the product information and not where users go to find help (optional)"
        }
      ],
      "properties": [
        {
          "name": "open",
          "attribute": "open",
          "description": "Determines if About Modal is open or not.",
          "type": "boolean",
          "default": "true"
        },
        {
          "name": "closeIconDescription",
          "attribute": "closeIconDescription",
          "description": "Determines if About Modal is open or not.",
          "type": "string",
          "default": "\"close\""
        },
        {
          "name": "copyrightText",
          "attribute": "copyrightText",
          "description": "Determines if About Modal is open or not."
        },
        {
          "name": "logo",
          "attribute": "logo",
          "description": "A visual symbol used to represent the product."
        },
        {
          "name": "version",
          "attribute": "version",
          "description": "Text that provides information on the version number of your product."
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Header text that provides the product name. The IBM Services logo consists of two discrete, but required, elements: the iconic IBM 8-bar logo represented alongside the IBM Services logotype. Please follow these guidelines to ensure proper execution."
        },
        {
          "name": "additionalInfo",
          "attribute": "additionalInfo",
          "description": "If you are legally required to display logos of technologies used to build your product you can provide this in the additionalInfo. Additional information will be displayed in the footer."
        },
        {
          "name": "content",
          "attribute": "content",
          "description": "Subhead text providing any relevant product disclaimers including legal information (optional)"
        },
        {
          "name": "links",
          "attribute": "links",
          "description": "An array of Carbon `Link` component if there are additional information to call out within the card. The about modal should be used to display the product information and not where users go to find help (optional)"
        },
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "size",
          "type": "number"
        },
        {
          "name": "customElements",
          "type": "CustomElementRegistry | undefined"
        },
        {
          "name": "registry",
          "type": "CustomElementRegistry | undefined"
        }
      ],
      "events": [
        {
          "name": "c4p-about-modal-closed",
          "description": "The custom event fired after this about modal is closed upon a user gesture."
        }
      ]
    },
    {
      "name": "c4p-full-page-error",
      "path": "./src/components/full-page-error/full-page-error.ts",
      "description": "FullPageError.",
      "attributes": [
        {
          "name": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ],
      "properties": [
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "label",
          "attribute": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "attribute": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "attribute": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ]
    },
    {
      "name": "elementName",
      "path": "./src/components/full-page-error/full-page-error.ts",
      "description": "FullPageError.",
      "attributes": [
        {
          "name": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ],
      "properties": [
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "label",
          "attribute": "label",
          "description": "Sets the label text",
          "type": "string",
          "default": "\"Error Label\""
        },
        {
          "name": "description",
          "attribute": "description",
          "description": "Sets the description text",
          "type": "string | undefined"
        },
        {
          "name": "kind",
          "attribute": "kind",
          "description": "Sets what kind of error it is. '404' | '403' | 'custom'",
          "type": "Kind",
          "default": "\"custom\""
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Sets the title text",
          "type": "string",
          "default": "\"Title\""
        }
      ]
    },
    {
      "name": "c4p-options-tile",
      "path": "./src/components/options-tile/options-tile.ts",
      "description": "OptionsTile.",
      "attributes": [
        {
          "name": "open",
          "description": "If `true` the body of the component is shown",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "title",
          "description": "Text for the title",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "titleId",
          "description": "ID for the title",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "size",
          "description": "Determines the size of the header",
          "type": "\"lg\" | \"xl\" | undefined",
          "default": "\"lg\""
        }
      ],
      "properties": [
        {
          "name": "open",
          "attribute": "open",
          "description": "If `true` the body of the component is shown",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Text for the title",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "titleId",
          "attribute": "titleId",
          "description": "ID for the title",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "size",
          "attribute": "size",
          "description": "Determines the size of the header",
          "type": "\"lg\" | \"xl\" | undefined",
          "default": "\"lg\""
        },
        {
          "name": "customElements",
          "type": "CustomElementRegistry | undefined"
        },
        {
          "name": "registry",
          "type": "CustomElementRegistry | undefined"
        }
      ],
      "events": [
        {
          "name": "c4p-options-tile-open",
          "description": "Custom event fired when tile is opened"
        },
        {
          "name": "c4p-options-tile-close",
          "description": "Custom event fired when tile is closed"
        }
      ],
      "cssParts": [
        {
          "name": "options",
          "description": "tile The options tile"
        }
      ]
    },
    {
      "name": "c4p-side-panel",
      "path": "./src/components/side-panel/side-panel.ts",
      "description": "SidePanel.",
      "attributes": [
        {
          "name": "animate-title",
          "description": "Determines if the title will animate on scroll",
          "type": "boolean",
          "default": "true"
        },
        {
          "name": "close-icon-description",
          "description": "Sets the close button icon description",
          "type": "string",
          "default": "\"Close\""
        },
        {
          "name": "condensed-actions",
          "description": "Determines whether the side panel should render the condensed version (affects action buttons primarily)",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "current-step",
          "description": "Sets the current step of the side panel"
        },
        {
          "name": "include-overlay",
          "description": "Determines whether the side panel should render with an overlay",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "label-text",
          "description": "Sets the label text which will display above the title text"
        },
        {
          "name": "navigation-back-icon-description",
          "description": "Sets the icon description for the navigation back icon button",
          "type": "string",
          "default": "\"Back\""
        },
        {
          "name": "open",
          "description": "`true` if the side-panel should be open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "placement",
          "description": "SidePanel placement.",
          "type": "SIDE_PANEL_PLACEMENT",
          "default": "\"right\""
        },
        {
          "name": "prevent-close-on-click-outside",
          "description": "Prevent closing on click outside of side-panel",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "selector-initial-focus",
          "description": "The initial location of focus in the side panel"
        },
        {
          "name": "selector-page-content",
          "description": "Selector for page content, used to push content to side except",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "slide-in",
          "description": "Determines if this panel slides in",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "title",
          "description": "Sets the title text"
        },
        {
          "name": "size",
          "description": "SidePanel size.",
          "type": "SIDE_PANEL_SIZE",
          "default": "\"md\""
        }
      ],
      "properties": [
        {
          "name": "animateTitle",
          "attribute": "animate-title",
          "description": "Determines if the title will animate on scroll",
          "type": "boolean",
          "default": "true"
        },
        {
          "name": "closeIconDescription",
          "attribute": "close-icon-description",
          "description": "Sets the close button icon description",
          "type": "string",
          "default": "\"Close\""
        },
        {
          "name": "condensedActions",
          "attribute": "condensed-actions",
          "description": "Determines whether the side panel should render the condensed version (affects action buttons primarily)",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "currentStep",
          "attribute": "current-step",
          "description": "Sets the current step of the side panel"
        },
        {
          "name": "includeOverlay",
          "attribute": "include-overlay",
          "description": "Determines whether the side panel should render with an overlay",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "labelText",
          "attribute": "label-text",
          "description": "Sets the label text which will display above the title text"
        },
        {
          "name": "navigationBackIconDescription",
          "attribute": "navigation-back-icon-description",
          "description": "Sets the icon description for the navigation back icon button",
          "type": "string",
          "default": "\"Back\""
        },
        {
          "name": "open",
          "attribute": "open",
          "description": "`true` if the side-panel should be open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "placement",
          "attribute": "placement",
          "description": "SidePanel placement.",
          "type": "SIDE_PANEL_PLACEMENT",
          "default": "\"right\""
        },
        {
          "name": "preventCloseOnClickOutside",
          "attribute": "prevent-close-on-click-outside",
          "description": "Prevent closing on click outside of side-panel",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "selectorInitialFocus",
          "attribute": "selector-initial-focus",
          "description": "The initial location of focus in the side panel"
        },
        {
          "name": "selectorPageContent",
          "attribute": "selector-page-content",
          "description": "Selector for page content, used to push content to side except",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "slideIn",
          "attribute": "slide-in",
          "description": "Determines if this panel slides in",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "title",
          "attribute": "title",
          "description": "Sets the title text"
        },
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "size",
          "attribute": "size",
          "description": "SidePanel size.",
          "type": "SIDE_PANEL_SIZE",
          "default": "\"md\""
        },
        {
          "name": "customElements",
          "type": "CustomElementRegistry | undefined"
        },
        {
          "name": "registry",
          "type": "CustomElementRegistry | undefined"
        }
      ],
      "events": [
        {
          "name": "c4p-side-panel-beingclosed",
          "description": "The custom event fired before this side-panel is being closed upon a user gesture.\nCancellation of this event stops the user-initiated action of closing this side-panel."
        },
        {
          "name": "c4p-side-panel-closed",
          "description": "The custom event fired after this side-panel is closed upon a user gesture."
        },
        {
          "name": "c4p-side-panel-navigate-back",
          "description": "custom event fired when clicking navigate back (available when step > 0)"
        }
      ]
    },
    {
      "name": "c4p-tearsheet",
      "path": "./src/components/tearsheet/tearsheet.ts",
      "description": "Tearsheet.",
      "attributes": [
        {
          "name": "aria-label",
          "description": "Optional aria label for the tearsheet",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "close-icon-description",
          "description": "Sets the close button icon description",
          "type": "string",
          "default": "\"Close\""
        },
        {
          "name": "has-close-icon",
          "description": "Enable a close icon ('x') in the header area of the tearsheet. By default,\n(when this prop is omitted, or undefined or null) a tearsheet does not\ndisplay a close icon if there are navigation actions (\"transactional\ntearsheet\") and displays one if there are no navigation actions (\"passive\ntearsheet\"), and that behavior can be overridden if required by setting\nthis prop to either true or false.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "influencer-placement",
          "description": "The placement of the influencer section, 'left' or 'right'.",
          "type": "TEARSHEET_INFLUENCER_PLACEMENT",
          "default": "\"right\""
        },
        {
          "name": "influencer-width",
          "description": "The width of the influencer section, 'narrow' or 'wide'.",
          "type": "TEARSHEET_INFLUENCER_WIDTH",
          "default": "\"narrow\""
        },
        {
          "name": "open",
          "description": "`true` if the tearsheet should be open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "prevent-close-on-click-outside",
          "description": "Prevent closing on click outside of tearsheet",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "selector-initial-focus",
          "description": "The initial location of focus in the side panel"
        },
        {
          "name": "width",
          "description": "The width of the influencer section, 'narrow' or 'wide'.",
          "type": "TEARSHEET_WIDTH",
          "default": "\"narrow\""
        }
      ],
      "properties": [
        {
          "name": "ariaLabel",
          "attribute": "aria-label",
          "description": "Optional aria label for the tearsheet",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "closeIconDescription",
          "attribute": "close-icon-description",
          "description": "Sets the close button icon description",
          "type": "string",
          "default": "\"Close\""
        },
        {
          "name": "hasCloseIcon",
          "attribute": "has-close-icon",
          "description": "Enable a close icon ('x') in the header area of the tearsheet. By default,\n(when this prop is omitted, or undefined or null) a tearsheet does not\ndisplay a close icon if there are navigation actions (\"transactional\ntearsheet\") and displays one if there are no navigation actions (\"passive\ntearsheet\"), and that behavior can be overridden if required by setting\nthis prop to either true or false.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "influencerPlacement",
          "attribute": "influencer-placement",
          "description": "The placement of the influencer section, 'left' or 'right'.",
          "type": "TEARSHEET_INFLUENCER_PLACEMENT",
          "default": "\"right\""
        },
        {
          "name": "influencerWidth",
          "attribute": "influencer-width",
          "description": "The width of the influencer section, 'narrow' or 'wide'.",
          "type": "TEARSHEET_INFLUENCER_WIDTH",
          "default": "\"narrow\""
        },
        {
          "name": "open",
          "attribute": "open",
          "description": "`true` if the tearsheet should be open.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "preventCloseOnClickOutside",
          "attribute": "prevent-close-on-click-outside",
          "description": "Prevent closing on click outside of tearsheet",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "selectorInitialFocus",
          "attribute": "selector-initial-focus",
          "description": "The initial location of focus in the side panel"
        },
        {
          "name": "width",
          "attribute": "width",
          "description": "The width of the influencer section, 'narrow' or 'wide'.",
          "type": "TEARSHEET_WIDTH",
          "default": "\"narrow\""
        },
        {
          "name": "actionsMultiple",
          "type": "string",
          "default": "\"['', 'single', 'double', 'triple'][this._actionsCount]\""
        },
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "size",
          "type": "number"
        },
        {
          "name": "customElements",
          "type": "CustomElementRegistry | undefined"
        },
        {
          "name": "registry",
          "type": "CustomElementRegistry | undefined"
        }
      ],
      "events": [
        {
          "name": "c4p-tearsheet-beingclosed",
          "description": "The custom event fired before this tearsheet is being closed upon a user gesture.\nCancellation of this event stops the user-initiated action of closing this tearsheet."
        },
        {
          "name": "c4p-tearsheet-closed",
          "description": "The custom event fired after this tearsheet is closed upon a user gesture."
        }
      ]
    },
    {
      "name": "c4p-user-avatar",
      "path": "./src/components/user-avatar/user-avatar.ts",
      "description": "Useravatar.",
      "attributes": [
        {
          "name": "tooltip-text",
          "description": "Specify the text of the tooltip.\nCan be string"
        },
        {
          "name": "tooltip-alignment",
          "description": "Specify the alignment of the tooltip.",
          "type": "string",
          "default": "\"bottom\""
        },
        {
          "name": "name",
          "description": "When passing the name prop, either send the initials to be used or the user's full name. The first two capital letters of the user's name will be used as the name."
        },
        {
          "name": "image",
          "description": "When passing the image prop, supply a full path to the image to be displayed."
        },
        {
          "name": "image-description",
          "description": "When passing the image prop use the imageDescription prop to describe the image for screen reader."
        },
        {
          "name": "background-color",
          "description": "Provide the background color need to be set for UserAvatar.",
          "type": "string",
          "default": "\"order-1-cyan\""
        },
        {
          "name": "theme",
          "description": "Set theme in which the component will be rendered."
        },
        {
          "name": "size",
          "description": "Set the size of the avatar circle"
        }
      ],
      "properties": [
        {
          "name": "tooltipText",
          "attribute": "tooltip-text",
          "description": "Specify the text of the tooltip.\nCan be string"
        },
        {
          "name": "tooltipAlignment",
          "attribute": "tooltip-alignment",
          "description": "Specify the alignment of the tooltip.",
          "type": "string",
          "default": "\"bottom\""
        },
        {
          "name": "name",
          "attribute": "name",
          "description": "When passing the name prop, either send the initials to be used or the user's full name. The first two capital letters of the user's name will be used as the name."
        },
        {
          "name": "image",
          "attribute": "image",
          "description": "When passing the image prop, supply a full path to the image to be displayed."
        },
        {
          "name": "imageDescription",
          "attribute": "image-description",
          "description": "When passing the image prop use the imageDescription prop to describe the image for screen reader."
        },
        {
          "name": "backgroundColor",
          "attribute": "background-color",
          "description": "Provide the background color need to be set for UserAvatar.",
          "type": "string",
          "default": "\"order-1-cyan\""
        },
        {
          "name": "theme",
          "attribute": "theme",
          "description": "Set theme in which the component will be rendered."
        },
        {
          "name": "styles",
          "default": "\"styles\""
        },
        {
          "name": "size",
          "attribute": "size",
          "description": "Set the size of the avatar circle"
        },
        {
          "name": "customElements",
          "type": "CustomElementRegistry | undefined"
        },
        {
          "name": "registry",
          "type": "CustomElementRegistry | undefined"
        }
      ]
    }
  ]
}