\r\n This legacy package has been deprecated in favor of the updated Gameface UI suite. \r\n Please switch to the official framework at Gameface UI.\r\n
\r\nPromise\r\nCreate and add a script tag with given url.\r\n\r\nThe `loadResource` method is used to load a component's template file. It receives the component as an argument and returns a Promise that resolves with the prepared template. This is usually done in the `connectedCallback`:\r\n\r\n```\r\nconnectedCallback() {\r\n components.loadResource(this)\r\n .then(this.init)\r\n .catch(err => console.error(err));\r\n}\r\n```\r\n\r\n\r\n\r\n**Kind**: instance method of [GamefaceComponents](#GamefaceComponents)\r\n**Returns**: promise - Resolved with the prepared template.\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| component | CustomElement Instance | Reference to the custom element. |\r\n\r\n\r\n\r\n### GamefaceComponents.renderOnce(component) => boolean\r\n\r\n**Kind**: instance method of [GamefaceComponents](#GamefaceComponents)\r\n**Returns**: boolean - `false` if the element was already rendered, `true` if it was not.\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| component | CustomElement instance | Reference to the custom component. |\r\n\r\n\r\n\r\n### GamefaceComponents.defineCustomElement(name, element)\r\nDefines a custom element.\r\n\r\n**Kind**: instance method of [GamefaceComponents](#GamefaceComponents)\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| name | string | The name of the element. |\r\n| element | Object | The object which describes the element. |\r\n\r\n\r\n# Exported Classes\r\n\r\n## BaseComponent\r\n\r\nThe base component from which all custom elements inherit. Implements all common functionality such as `instanceType` getter and `setupTemplate` method.\r\n\r\n\r\n\r\n### BaseComponent.instanceType => string\r\n\r\nReturns the type of the instance as a string literal.\r\n\r\n\r\n\r\n### BaseComponent.setupTemplate(data, callback) => void\r\n\r\nSets the template of the component and invokes a given callback when ready.\r\n\r\n**Kind**: instance method of [GamefaceComponents](#GamefaceComponents)\r\n**Returns**: void\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| data | string | The result from loadResource. |\r\n| callback | function | Called when the template is set up. |\r\n\r\n\r\n## Validator\r\n\r\nA static class used to validate UI elements. It it the most basic type of validator exported by the components library. Implements the following methods:\r\n\r\n### Validator.isFormElement(element) => boolean\r\n\r\nChecks if the given element is part of a form.\r\n\r\n### Validator.tooLong() => boolean\r\n### Validator.tooShort() => boolean\r\n### Validator.rangeOverflow() => boolean\r\n### Validator.rangeUnderflow() => boolean\r\n### Validator.customError() => boolean\r\n### Validator.isBadURL() => boolean\r\n### Validator.isBadEmail() => boolean\r\n\r\nEmpty implementations, always return `false`.\r\n\r\n### Validator.valueMissing(element) => boolean\r\n\r\nChecks if the given elements has a required attribute and if its value is missing.\r\n\r\n### Validator.nameMissing(element) => boolean\r\n\r\nChecks if the element has a name attribute.\r\n\r\n### Validator.isRequired(element) => boolean\r\n\r\nChecks if the element has a required attribute.\r\n\r\n### Validator.willSerialize(element) => boolean\r\n\r\nChecks if the element is going to be serialized, if it is valid.\r\n\r\n\r\n## NativeElementValidator\r\n\r\nA class that implements the same methods as the `Validator` class but overwrites the ones specific to a native HTML element such as an ``.\r\n\r\n### NativeElementValidator.tooLong() => boolean\r\n### NativeElementValidator.tooShort() => boolean\r\n### NativeElementValidator.rangeOverflow() => boolean\r\n### NativeElementValidator.rangeUnderflow() => boolean\r\n### NativeElementValidator.isBadURL() => boolean\r\n### NativeElementValidator.isBadEmail() => boolean\r\n\r\nChecks if the element is native text field and calls the native element's specific implementation of one of the above listed methods. If the element is not native - uses the same named method from the `Validator` class.\r\n\r\n### NativeElementValidator.isFormElement() => boolean\r\n### NativeElementValidator.customError() => boolean\r\n### NativeElementValidator.nameMissing() => boolean\r\n### NativeElementValidator.valueMissing() => boolean\r\n### NativeElementValidator.isRequired() => boolean\r\n### NativeElementValidator.willSerialize() => boolean\r\n\r\nUses the implementation from the `Validator` class.\r\n\r\n\r\n## CustomElementValidator\r\n\r\nAll components that need validation extend this class. It inherits the BaseComponent making all that extend the CustomElementValidator `CustomElement` instances. Uses all validation methods from the `Validator` class.\r\n\r\n\r\n## TextFieldValidator\r\n\r\nA static class that implements text field specific validation methods:\r\n\r\n### TextFieldValidator.tooLong(element) => boolean\r\n### TextFieldValidator.tooShort(element) => boolean\r\n\r\nCheck if the value of the text field contains more or less symbols than the value of its `maxLength` and `minLength` attribute respectively. Returns `false` if the element has no `maxLength` or `minLength` attribute.\r\n\r\n**Kind**: static method of [TextFieldValidator](##TextFieldValidator)\r\n**Returns**: boolean\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| element | HTMLElement | The text field instance. |\r\n\r\n### TextFieldValidator.tooShort(element) => boolean\r\n\r\nChecks if the value of the text field contains less symbols than the value of its `minLength` attribute. Returns `false` if the element has no `minLength` attribute.\r\n\r\n**Kind**: static method of [TextFieldValidator](##TextFieldValidator)\r\n**Returns**: boolean\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| element | HTMLElement | The text field instance. |\r\n\r\n### TextFieldValidator.rangeOverflow(element) => boolean\r\n### TextFieldValidator.rangeUnderflow(element) => boolean\r\n\r\nChecks if the value of the element is bigger or smaller than its `max` or `min` attribute respectively. Useful for sliders. Returns `false` if the element has no `max` or `min` attribute.\r\n\r\n**Kind**: static method of [TextFieldValidator](##TextFieldValidator)\r\n**Returns**: boolean\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| element | HTMLElement | The text field instance. |\r\n\r\n### TextFieldValidator.isBadURL(element) => boolean\r\n\r\nChecks if the text of an element is a valid URL by testing its value against the element's pattern attribute using regular expression matching. Returns `false` if the element's type is not 'url' or if it doesn't have a `pattern` attribute.\r\n\r\n**Kind**: static method of [TextFieldValidator](##TextFieldValidator)\r\n**Returns**: boolean\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| element | HTMLElement | The text field instance. |\r\n\r\n### TextFieldValidator.isBadEmail(element) => boolean\r\n\r\nValidates if the value of a text field is a valid email by checking if it contains a `@` symbol. Returns `false` if the element's type attribute is not `email`.\r\n\r\n**Kind**: static method of [TextFieldValidator](##TextFieldValidator)\r\n**Returns**: boolean\r\n\r\n| Param | Type | Description |\r\n| --- | --- | --- |\r\n| element | HTMLElement | The text field instance. |","readmeFilename":"README.md"}