@aurodesignsystem/auro-background/custom-elements.json

auro-background HTML custom element

{
  "schemaVersion": "1.0.0",
  "readme": "",
  "modules": [
    {
      "kind": "javascript-module",
      "path": "src/auro-background.js",
      "declarations": [
        {
          "kind": "class",
          "description": "The `auro-background` element provides users a way to add a background image or color block including a gradient.",
          "name": "AuroBackground",
          "slots": [
            {
              "description": "Default slot for content within the background container.",
              "name": ""
            }
          ],
          "members": [
            {
              "kind": "field",
              "name": "bg",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at all breakpoints",
              "attribute": "bg"
            },
            {
              "kind": "field",
              "name": "bgLg",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at `ds-grid-breakpoint-lg` and above",
              "attribute": "bgLg"
            },
            {
              "kind": "field",
              "name": "bgMd",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at `ds-grid-breakpoint-md` and above",
              "attribute": "bgMd"
            },
            {
              "kind": "field",
              "name": "bgSm",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at `ds-grid-breakpoint-sm` and above",
              "attribute": "bgSm"
            },
            {
              "kind": "method",
              "name": "getInsetValues",
              "parameters": [
                {
                  "name": "inset",
                  "description": "Value from host attribute.",
                  "type": {
                    "text": "string"
                  }
                }
              ],
              "privacy": "private",
              "return": {
                "type": {
                  "text": "string"
                }
              }
            },
            {
              "kind": "field",
              "name": "height",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at all breakpoints",
              "attribute": "height"
            },
            {
              "kind": "field",
              "name": "heightLg",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at `ds-grid-breakpoint-lg` and above",
              "attribute": "heightLg"
            },
            {
              "kind": "field",
              "name": "heightMd",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at `ds-grid-breakpoint-md` and above",
              "attribute": "heightMd"
            },
            {
              "kind": "field",
              "name": "heightSm",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at `ds-grid-breakpoint-sm` and above",
              "attribute": "heightSm"
            },
            {
              "kind": "field",
              "name": "inset",
              "privacy": "public",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at all breakpoints",
              "attribute": "inset"
            },
            {
              "kind": "field",
              "name": "insetLg",
              "privacy": "public",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at `ds-grid-breakpoint-lg` and above",
              "attribute": "insetLg"
            },
            {
              "kind": "field",
              "name": "insetMd",
              "privacy": "public",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at `ds-grid-breakpoint-md` and above",
              "attribute": "insetMd"
            },
            {
              "kind": "field",
              "name": "insetSm",
              "privacy": "public",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at `ds-grid-breakpoint-sm` and above",
              "attribute": "insetSm"
            },
            {
              "kind": "method",
              "name": "register",
              "static": true,
              "parameters": [
                {
                  "name": "name",
                  "default": "\"auro-background\"",
                  "description": "The name of the element that you want to register.",
                  "optional": true,
                  "type": {
                    "text": "string"
                  }
                }
              ],
              "description": "This will register this element with the browser.",
              "type": {
                "text": "register(name?: string = \"auro-background\") => void"
              }
            },
            {
              "kind": "field",
              "name": "runtimeUtils",
              "privacy": "private",
              "default": "new AuroLibraryRuntimeUtils()"
            },
            {
              "kind": "field",
              "name": "width",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at all breakpoints",
              "attribute": "width"
            },
            {
              "kind": "field",
              "name": "widthLg",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at `ds-grid-breakpoint-lg` and above",
              "attribute": "widthLg"
            },
            {
              "kind": "field",
              "name": "widthMd",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at `ds-grid-breakpoint-md` and above",
              "attribute": "widthMd"
            },
            {
              "kind": "field",
              "name": "widthSm",
              "privacy": "public",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at `ds-grid-breakpoint-sm` and above",
              "attribute": "widthSm"
            }
          ],
          "attributes": [
            {
              "name": "bg",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at all breakpoints",
              "fieldName": "bg"
            },
            {
              "name": "bgLg",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at `ds-grid-breakpoint-lg` and above",
              "fieldName": "bgLg"
            },
            {
              "name": "bgMd",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at `ds-grid-breakpoint-md` and above",
              "fieldName": "bgMd"
            },
            {
              "name": "bgSm",
              "type": {
                "text": "string"
              },
              "description": "Sets the background image at `ds-grid-breakpoint-sm` and above",
              "fieldName": "bgSm"
            },
            {
              "name": "height",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at all breakpoints",
              "fieldName": "height"
            },
            {
              "name": "heightLg",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at `ds-grid-breakpoint-lg` and above",
              "fieldName": "heightLg"
            },
            {
              "name": "heightMd",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at `ds-grid-breakpoint-md` and above",
              "fieldName": "heightMd"
            },
            {
              "name": "heightSm",
              "type": {
                "text": "string"
              },
              "description": "Applies custom height at `ds-grid-breakpoint-sm` and above",
              "fieldName": "heightSm"
            },
            {
              "name": "inset",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at all breakpoints",
              "fieldName": "inset"
            },
            {
              "name": "insetLg",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at `ds-grid-breakpoint-lg` and above",
              "fieldName": "insetLg"
            },
            {
              "name": "insetMd",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at `ds-grid-breakpoint-md` and above",
              "fieldName": "insetMd"
            },
            {
              "name": "insetSm",
              "type": {
                "text": "'none' | 'xxxs' | 'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl' | string"
              },
              "description": "Applies internal padding at `ds-grid-breakpoint-sm` and above",
              "fieldName": "insetSm"
            },
            {
              "name": "width",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at all breakpoints",
              "fieldName": "width"
            },
            {
              "name": "widthLg",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at `ds-grid-breakpoint-lg` and above",
              "fieldName": "widthLg"
            },
            {
              "name": "widthMd",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at `ds-grid-breakpoint-md` and above",
              "fieldName": "widthMd"
            },
            {
              "name": "widthSm",
              "type": {
                "text": "string"
              },
              "description": "Applies custom width at `ds-grid-breakpoint-sm` and above",
              "fieldName": "widthSm"
            }
          ],
          "superclass": {
            "name": "LitElement",
            "package": "lit"
          },
          "tagName": "auro-background",
          "customElement": true,
          "modulePath": "src/auro-background.js"
        }
      ],
      "exports": [
        {
          "kind": "js",
          "name": "AuroBackground",
          "declaration": {
            "name": "AuroBackground",
            "module": "src/auro-background.js"
          }
        }
      ]
    },
    {
      "kind": "javascript-module",
      "path": "src/index.js",
      "declarations": [],
      "exports": [
        {
          "kind": "js",
          "name": "AuroBackground",
          "declaration": {
            "name": "AuroBackground",
            "module": "src/index.js"
          }
        }
      ]
    },
    {
      "kind": "javascript-module",
      "path": "src/registered.js",
      "declarations": [],
      "exports": []
    }
  ]
}