@haxtheweb/simple-colors
Version:
Automated conversion of simple-colors/
403 lines (402 loc) • 9.67 kB
JSON
{
"schema_version": "1.0.0",
"classes": [
{
"description": "",
"summary": "",
"path": "simple-colors.js",
"properties": [],
"methods": [
{
"name": "render",
"description": "render function",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1095,
"column": 4
},
"end": {
"line": 1097,
"column": 5
}
},
"metadata": {},
"params": []
},
{
"name": "invertShade",
"description": "gets the current shade",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1140,
"column": 4
},
"end": {
"line": 1142,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "shade"
}
]
},
{
"name": "getColorInfo",
"description": "gets the color information of a given CSS variable or class",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1150,
"column": 4
},
"end": {
"line": 1152,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "colorName"
}
]
},
{
"name": "makeVariable",
"description": "returns a variable based on color name, shade, and fixed theme",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1162,
"column": 4
},
"end": {
"line": 1168,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "color",
"defaultValue": "\"grey\""
},
{
"name": "shade",
"defaultValue": "1"
},
{
"name": "theme",
"defaultValue": "\"default\""
}
],
"return": {
"type": "string",
"desc": "the CSS Variable"
}
},
{
"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": 1180,
"column": 4
},
"end": {
"line": 1186,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "colorName"
},
{
"name": "colorShade"
},
{
"name": "isLarge"
}
]
},
{
"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": 1199,
"column": 4
},
"end": {
"line": 1206,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "isLarge"
},
{
"name": "colorName"
},
{
"name": "colorShade"
},
{
"name": "contrastName"
}
]
},
{
"name": "isContrastCompliant",
"description": "determines if two shades are WCAG 2.0 AA-compliant for contrast",
"privacy": "public",
"sourceRange": {
"start": {
"line": 1218,
"column": 4
},
"end": {
"line": 1232,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "isLarge"
},
{
"name": "colorName"
},
{
"name": "colorShade"
},
{
"name": "contrastName"
},
{
"name": "contrastShade"
}
]
}
],
"staticMethods": [],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 7,
"column": 9
},
"end": {
"line": 1233,
"column": 3
}
},
"privacy": "public",
"superclass": "SuperClass"
},
{
"description": "`simple-colors`\na shared set of styles for `@haxtheweb`\n ### Styling\n See demo of \"all of the colors\" (`demo/colors.html`) for styling.",
"summary": "",
"path": "simple-colors.js",
"properties": [],
"methods": [],
"staticMethods": [],
"demos": [
{
"url": "./demo/index.html",
"description": "demo"
},
{
"url": "./demo/how.html",
"description": "getting started"
},
{
"url": "./demo/colors.html",
"description": "all of the colors"
},
{
"url": "./demo/picker.html",
"description": "simple-colors-picker"
},
{
"url": "./demo/extending.html",
"description": "extending simple-colors"
},
{
"url": "./demo/index.html",
"description": "demo"
},
{
"url": "./demo/how.html",
"description": "getting started"
},
{
"url": "./demo/colors.html",
"description": "all of the colors"
},
{
"url": "./demo/picker.html",
"description": "simple-colors-picker"
},
{
"url": "./demo/extending.html",
"description": "extending simple-colors"
}
],
"metadata": {},
"sourceRange": {
"start": {
"line": 1249,
"column": 0
},
"end": {
"line": 1249,
"column": 59
}
},
"privacy": "public",
"name": "SimpleColors"
},
{
"description": "`simple-colors-picker`\na select element for changing `simple-colors` attributes in demos\n\n### Styling\nSee demo of \"all of the colors\" (`demo/colors.html`) for styling.",
"summary": "",
"path": "lib/simple-colors-picker.js",
"properties": [],
"methods": [
{
"name": "updated",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 47,
"column": 2
},
"end": {
"line": 60,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "changedProperties"
}
],
"return": {
"type": "void"
}
},
{
"name": "firstUpdated",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 83,
"column": 2
},
"end": {
"line": 88,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "changedProperties"
}
],
"return": {
"type": "void"
}
},
{
"name": "_getOptions",
"description": "gets options for the selectors",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 95,
"column": 2
},
"end": {
"line": 129,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "colors"
},
{
"name": "shades"
},
{
"name": "dark"
}
]
},
{
"name": "_fireChangeEvent",
"description": "Fires with any property change.",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 136,
"column": 2
},
"end": {
"line": 140,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
}
],
"staticMethods": [],
"demos": [
{
"url": "./demo/picker.html",
"description": "demo"
},
{
"url": "./demo/picker.html",
"description": "demo"
}
],
"metadata": {},
"sourceRange": {
"start": {
"line": 21,
"column": 0
},
"end": {
"line": 141,
"column": 1
}
},
"privacy": "public",
"superclass": "SimpleColors",
"name": "SimpleColorsPicker"
}
]
}