{ "title": "Abide", "description": "Abide is an form validation library that extends the HTML5 validation API with custom validators.", "sass": { "variable": [ { "description": "Sets if error styles should be added to inputs.\n", "commentRange": { "start": 9, "end": 10 }, "context": { "type": "variable", "name": "abide-inputs", "value": "true", "scope": "default", "line": { "start": 11, "end": 11 } }, "type": "Boolean", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" } }, { "description": "Sets if error styles should be added to labels.\n", "commentRange": { "start": 13, "end": 14 }, "context": { "type": "variable", "name": "abide-labels", "value": "true", "scope": "default", "line": { "start": 15, "end": 15 } }, "type": "Boolean", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" } }, { "description": "Background color to use for invalid text inputs.\n", "commentRange": { "start": 17, "end": 18 }, "context": { "type": "variable", "name": "input-background-invalid", "value": "map-get($foundation-palette, alert)", "scope": "default", "line": { "start": 19, "end": 19 } }, "type": "Color", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" } }, { "description": "Color to use for labels of invalid inputs.\n", "commentRange": { "start": 21, "end": 22 }, "context": { "type": "variable", "name": "form-label-color-invalid", "value": "map-get($foundation-palette, alert)", "scope": "default", "line": { "start": 23, "end": 23 } }, "type": "Color", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" } }, { "description": "Default font color for form error text.\n", "commentRange": { "start": 25, "end": 26 }, "context": { "type": "variable", "name": "input-error-color", "value": "map-get($foundation-palette, alert)", "scope": "default", "line": { "start": 27, "end": 27 } }, "type": "Color", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" }, "usedBy": [ { "description": "Adds error styles to a form element, using the values in the settings file.\n", "context": { "type": "mixin", "name": "form-error", "code": "\n display: none;\n margin-top: $form-spacing * -0.5;\n margin-bottom: $form-spacing;\n font-size: $input-error-font-size;\n font-weight: $input-error-font-weight;\n color: $input-error-color;\n", "line": { "start": 52, "end": 59 } } } ] }, { "description": "Default font size for form error text.\n", "commentRange": { "start": 29, "end": 30 }, "context": { "type": "variable", "name": "input-error-font-size", "value": "rem-calc(12)", "scope": "default", "line": { "start": 31, "end": 31 } }, "type": "Number", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" }, "usedBy": [ { "description": "Adds error styles to a form element, using the values in the settings file.\n", "context": { "type": "mixin", "name": "form-error", "code": "\n display: none;\n margin-top: $form-spacing * -0.5;\n margin-bottom: $form-spacing;\n font-size: $input-error-font-size;\n font-weight: $input-error-font-weight;\n color: $input-error-color;\n", "line": { "start": 52, "end": 59 } } } ] }, { "description": "Default font weight for form error text.\n", "commentRange": { "start": 33, "end": 34 }, "context": { "type": "variable", "name": "input-error-font-weight", "value": "$global-weight-bold", "scope": "default", "line": { "start": 35, "end": 35 } }, "type": "Keyword", "group": [ "abide" ], "access": "public", "file": { "path": "_error.scss", "name": "_error.scss" }, "usedBy": [ { "description": "Adds error styles to a form element, using the values in the settings file.\n", "context": { "type": "mixin", "name": "form-error", "code": "\n display: none;\n margin-top: $form-spacing * -0.5;\n margin-bottom: $form-spacing;\n font-size: $input-error-font-size;\n font-weight: $input-error-font-weight;\n color: $input-error-color;\n", "line": { "start": 52, "end": 59 } } } ] } ], "mixin": [ { "description": "Styles the background and border of an input field to have an error state.\n\n", "commentRange": { "start": 37, "end": 40 }, "context": { "type": "mixin", "name": "form-input-error", "code": "\n &:not(:focus) {\n background-color: rgba($background, $background-alpha);\n border-color: $background;\n }\n", "line": { "start": 41, "end": 49 } }, "parameter": [ { "type": "Color", "name": "background", "default": "$alert-color", "description": "Color to use for the background and border." }, { "type": "Number", "name": "background-alpha", "default": "0.1", "description": "Transparency level of the background color." } ], "group": [ "abide" ], "access": "public", "require": [], "file": { "path": "_error.scss", "name": "_error.scss" } }, { "description": "Adds error styles to a form element, using the values in the settings file.\n", "commentRange": { "start": 51, "end": 51 }, "context": { "type": "mixin", "name": "form-error", "code": "\n display: none;\n margin-top: $form-spacing * -0.5;\n margin-bottom: $form-spacing;\n font-size: $input-error-font-size;\n font-weight: $input-error-font-weight;\n color: $input-error-color;\n", "line": { "start": 52, "end": 59 } }, "group": [ "abide" ], "access": "public", "require": [ { "type": "variable", "name": "input-error-font-size" }, { "type": "variable", "name": "input-error-font-weight" }, { "type": "variable", "name": "input-error-color" } ], "file": { "path": "_error.scss", "name": "_error.scss" } } ] }, "js": { "module": [ { "comment": "/**\n * Abide module.\n * @module foundation.abide\n */", "meta": { "range": [ 31, 83 ], "filename": "foundation.abide.js", "lineno": 5, "path": "/Users/geoff/Sites/fs/js", "code": {} }, "description": "Abide module.", "kind": "module", "name": "abide", "memberof": "foundation", "longname": "foundation.module:abide", "scope": "static" } ], "class": [ { "comment": "/**\n * Creates a new instance of Abide.\n * @class\n * @fires Abide#init\n * @param {Object} element - jQuery object to add the trigger to.\n * @param {Object} options - Overrides to the default plugin settings.\n */", "meta": { "range": [ 327, 543 ], "filename": "foundation.abide.js", "lineno": 18, "path": "/Users/geoff/Sites/fs/js", "code": { "id": "astnode100000012", "name": "Abide", "type": "MethodDefinition", "paramnames": [ "element", "options" ] }, "vars": { "": null } }, "description": "Creates a new instance of Abide.", "kind": "class", "fires": [ "Abide#event:init" ], "params": [ { "type": { "names": [ "Object" ] }, "description": "jQuery object to add the trigger to.", "name": "element" }, { "type": { "names": [ "Object" ] }, "description": "Overrides to the default plugin settings.", "name": "options" } ], "name": "Abide", "longname": "foundation.module:abide~Abide.Abide", "memberof": "foundation.module:abide~Abide", "scope": "static" } ], "function": [ { "comment": "/**\n * Checks whether or not a form element has the required attribute and if it's checked or not\n * @param {Object} element - jQuery object to check for required attribute\n * @returns {Boolean} Boolean value depends on whether or not attribute is checked or empty\n */", "meta": { "range": [ 1857, 2364 ], "filename": "foundation.abide.js", "lineno": 80, "path": "/Users/geoff/Sites/fs/js", "code": { "id": "astnode100000192", "name": "Abide#requiredCheck", "type": "MethodDefinition", "paramnames": [ "$el" ] }, "vars": { "": null } }, "description": "Checks whether or not a form element has the required attribute and if it's checked or not", "params": [ { "type": { "names": [ "Object" ] }, "description": "jQuery object to check for required attribute", "name": "element" } ], "returns": [ { "type": { "names": [ "Boolean" ] }, "description": "Boolean value depends on whether or not attribute is checked or empty" } ], "name": "requiredCheck", "longname": "foundation.module:abide~Abide#requiredCheck", "kind": "function", "memberof": "foundation.module:abide~Abide", "scope": "instance" }, { "comment": "/**\n * Based on $el, get the first element with selector in this order:\n * 1. The element's direct sibling('s).\n * 3. The element's parent's children.\n *\n * This allows for multiple form errors per input, though if none are found, no form errors will be shown.\n *\n * @param {Object} $el - jQuery object to use as reference to find the form error selector.\n * @returns {Object} jQuery object with the selector.\n */", "meta": { "range": [ 2802, 3008 ], "filename": "foundation.abide.js", "lineno": 115, "path": "/Users/geoff/Sites/fs/js", "code": { "id": "astnode100000280", "name": "Abide#findFormError", "type": "MethodDefinition", "paramnames": [ "$el" ] }, "vars": { "": null } }, "description": "Based on $el, get the first element with selector in this order:\n1. The element's direct sibling('s).\n3. The element's parent's children.\n\nThis allows for multiple form errors per input, though if none are found, no form errors will be shown.", "params": [ { "type": { "names": [ "Object" ] }, "description": "jQuery object to use as reference to find the form error selector.", "name": "$el" } ], "returns": [ { "type": { "names": [ "Object" ] }, "description": "jQuery object with the selector." } ], "name": "findFormError", "longname": "foundation.module:abide~Abide#findFormError", "kind": "function", "memberof": "foundation.module:abide~Abide", "scope": "instance" }, { "comment": "/**\n * Get the first element in this order:\n * 2. The