@lrnwebcomponents/simple-colors-shared-styles/analysis.json

shared styles for simple-colors

{
  "schema_version": "1.0.0",
  "classes": [
    {
      "description": "",
      "summary": "",
      "path": "simple-colors-shared-styles.js",
      "properties": [],
      "methods": [
        {
          "name": "render",
          "description": "render function",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 547,
              "column": 2
            },
            "end": {
              "line": 549,
              "column": 3
            }
          },
          "metadata": {},
          "params": []
        },
        {
          "name": "getColorInfo",
          "description": "gets the color information of a given CSS variable or class",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 936,
              "column": 2
            },
            "end": {
              "line": 950,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "colorName"
            }
          ]
        },
        {
          "name": "makeVariable",
          "description": "returns a variable based on color name, shade, and fixed theme",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 959,
              "column": 2
            },
            "end": {
              "line": 961,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "color",
              "defaultValue": "\"grey\""
            },
            {
              "name": "shade",
              "defaultValue": "1"
            },
            {
              "name": "theme",
              "defaultValue": "\"default\""
            }
          ],
          "return": {
            "type": "string",
            "desc": "the CSS Variable"
          }
        },
        {
          "name": "getContrastingShades",
          "description": "for large or small text given a color and its shade,\nlists all the shades of another color that would be\nWCAG 2.0 AA-compliant for contrast",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 973,
              "column": 2
            },
            "end": {
              "line": 984,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "isLarge"
            },
            {
              "name": "colorName"
            },
            {
              "name": "colorShade"
            },
            {
              "name": "contrastName"
            }
          ]
        },
        {
          "name": "getContrastingColors",
          "description": "for large or small text given a color and its shade,\nlists all the colors and shades that would be\nWCAG 2.0 AA-compliant for contrast",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 996,
              "column": 2
            },
            "end": {
              "line": 1007,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "colorName"
            },
            {
              "name": "colorShade"
            },
            {
              "name": "isLarge"
            }
          ]
        },
        {
          "name": "isContrastCompliant",
          "description": "determines if two shades are WCAG 2.0 AA-compliant for contrast",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 1018,
              "column": 2
            },
            "end": {
              "line": 1033,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "isLarge"
            },
            {
              "name": "colorName"
            },
            {
              "name": "colorShade"
            },
            {
              "name": "contrastName"
            },
            {
              "name": "contrastShade"
            }
          ]
        },
        {
          "name": "indexToShade",
          "description": "gets the current shade based on the index",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 1041,
              "column": 2
            },
            "end": {
              "line": 1043,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "index"
            }
          ]
        },
        {
          "name": "shadeToIndex",
          "description": "gets the current shade based on the index",
          "privacy": "public",
          "sourceRange": {
            "start": {
              "line": 1051,
              "column": 2
            },
            "end": {
              "line": 1053,
              "column": 3
            }
          },
          "metadata": {},
          "params": [
            {
              "name": "shade"
            }
          ]
        }
      ],
      "staticMethods": [],
      "demos": [],
      "metadata": {},
      "sourceRange": {
        "start": {
          "line": 17,
          "column": 0
        },
        "end": {
          "line": 1054,
          "column": 1
        }
      },
      "privacy": "public",
      "superclass": "LitElement",
      "name": "SimpleColorsSharedStyles"
    }
  ]
}