@riovir/wc-fontawesome/custom-elements.json

Web components for Font Awesome

{
  "version": "experimental",
  "tags": [
    {
      "name": "font-awesome-icon",
      "path": "./src\\index.d.ts",
      "properties": [
        {
          "name": "icon",
          "description": "Icon definition. Can be one of the following: <br />\r\n- string: name of registered icons with the default prefix <br />\r\n- array: of 'prefix', 'name' for registered icons with non-default prefix <br />\r\n- object: the icon definition directly without the need to register it",
          "type": "string|array|object",
          "default": "\"\""
        },
        {
          "name": "resolvedIcon",
          "description": "(Read only) The resolved icon definition.",
          "type": "object|undefined"
        },
        {
          "name": "size",
          "description": "one of the 'xs', 'xm', 'lg', '1x', '2x', ... '10x' sizes",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "rotateBy",
          "description": "sets the rotation to an arbitrary value. The degree is set by the --fa-rotate-angle CSS variable.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "rotation",
          "description": "one of the '90', '180', '270' rotations. For more control, use the transform prop.",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "flip",
          "description": "one of the 'horizontal', 'vertical', 'both' flip options",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "pull",
          "description": "one of the 'left', 'right' options to float the element",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "fixedWidth",
          "description": "fixes the width. Commonly used for aligning lists of icons. Since v7, this is the default.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "widthAuto",
          "description": "matches the icon width to the shape. Commonly used with flowing text. Used to be the default prior v7.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "spin",
          "description": "sets the icon spinning. Commonly used for loading indicators",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "pulse",
          "description": "alternative to spinning. Commonly used with the spinner icon",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "inverse",
          "description": "inverts the icon color",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "swapOpacity",
          "description": "swaps duotone icon layer opacities",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "mask",
          "description": "same as icon, to use its shape as a mask. <br />\r\nUsed together with transform for proper relative sizing.",
          "type": "string|array|object",
          "default": "\"\""
        },
        {
          "name": "resolvedMask",
          "description": "(Read only) The resolved mask's icon definition.",
          "type": "object|undefined"
        },
        {
          "name": "transform",
          "description": "Transformation. Can be one of the following: <br />\r\n- string: to be parsed into the object form <br />\r\n- object: the transform definition directly",
          "type": "string|object",
          "default": "\"\""
        },
        {
          "name": "parsedTransform",
          "description": "(Read only) Transformation parsed into object form.",
          "type": "object|undefined"
        }
      ],
      "cssProperties": [
        {
          "name": "--fa-primary-color",
          "description": "Duotone icons only: primary background color",
          "default": "\"currentColor\""
        },
        {
          "name": "--fa-secondary-color",
          "description": "Duotone icons only: secondary background color",
          "default": "\"currentColor\""
        },
        {
          "name": "--fa-primary-opacity",
          "description": "Duotone icons only: primary opacity (unless swapOpacity used)",
          "default": "1"
        },
        {
          "name": "--fa-secondary-opacity",
          "description": "Duotone icons only: secondary opacity (unless swapOpacity used)",
          "default": "0.4"
        }
      ],
      "deprecated": true
    },
    {
      "name": "font-awesome-layers-text",
      "path": "./src\\index.d.ts",
      "properties": [
        {
          "name": "value",
          "description": "value to be displayed",
          "type": "string|number",
          "default": "\"\""
        },
        {
          "name": "counter",
          "description": "set to turn it to a counter subtype",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "size",
          "description": "one of the 'xs', 'xm', 'lg', '1x', '2x', ... '10x' sizes",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "fixedWidth",
          "description": "fixes the width. Commonly used for aligning lists of icons. Since v7, this is the default.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "widthAuto",
          "description": "matches the icon width to the shape. Commonly used with flowing text. Used to be the default prior v7.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "position",
          "description": "one of the 'top-left', 'top-right', 'bottom-left', 'bottom-right' positions",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "inverse",
          "description": "inverts the icon color",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "transform",
          "description": "Transformation. Can be one of the following: <br />\r\n- string: to be parsed into the object form <br />\r\n- object: the transform definition directly",
          "type": "string|object",
          "default": "\"\""
        },
        {
          "name": "parsedTransform",
          "description": "(Read only) Transformation parsed into object form.",
          "type": "object|undefined"
        }
      ],
      "cssProperties": [
        {
          "name": "--fa-layers-counter-background",
          "description": "background color of the counter",
          "default": "\"#ff253a\""
        }
      ],
      "deprecated": true
    },
    {
      "name": "font-awesome-layers",
      "path": "./src\\index.d.ts",
      "properties": [
        {
          "name": "size",
          "description": "one of the 'xs', 'xm', 'lg', '1x', '2x', ... '10x' sizes",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "pull",
          "description": "one of the 'left', 'right' options to float the element",
          "type": "string",
          "default": "\"\""
        },
        {
          "name": "fixedWidth",
          "description": "fixes the width. Commonly used for aligning lists of icons. Since v7, this is the default.",
          "type": "boolean",
          "default": "false"
        },
        {
          "name": "widthAuto",
          "description": "matches the icon width to the shape. Commonly used with flowing text. Used to be the default prior v7.",
          "type": "boolean",
          "default": "false"
        }
      ],
      "deprecated": true
    }
  ]
}