diff --git a/0859d4840ac51c9600f0.eot b/4122c5f28d2e47944553.eot similarity index 99% rename from 0859d4840ac51c9600f0.eot rename to 4122c5f28d2e47944553.eot index 2b47c617df..591f480c3b 100644 Binary files a/0859d4840ac51c9600f0.eot and b/4122c5f28d2e47944553.eot differ diff --git a/5dd80f21c02f6b8a854d.woff b/4bcd5a36c7a107e6da2a.woff similarity index 99% rename from 5dd80f21c02f6b8a854d.woff rename to 4bcd5a36c7a107e6da2a.woff index c073d5a0b4..13e54912a7 100644 Binary files a/5dd80f21c02f6b8a854d.woff and b/4bcd5a36c7a107e6da2a.woff differ diff --git a/42426daba56305d26181.woff b/b14a3f72732fc553f31d.woff similarity index 99% rename from 42426daba56305d26181.woff rename to b14a3f72732fc553f31d.woff index 1838768d00..e56f4db309 100644 Binary files a/42426daba56305d26181.woff and b/b14a3f72732fc553f31d.woff differ diff --git a/48b536edb7a1de645e2b.ttf b/bc5b657ab6f18836a036.ttf similarity index 99% rename from 48b536edb7a1de645e2b.ttf rename to bc5b657ab6f18836a036.ttf index 54b3bf160a..e202c119cb 100644 Binary files a/48b536edb7a1de645e2b.ttf and b/bc5b657ab6f18836a036.ttf differ diff --git a/2b6948f186d1687cd1ea.eot b/dd0f27ff902c97b9344a.eot similarity index 99% rename from 2b6948f186d1687cd1ea.eot rename to dd0f27ff902c97b9344a.eot index 9516337c26..7078ad8576 100644 Binary files a/2b6948f186d1687cd1ea.eot and b/dd0f27ff902c97b9344a.eot differ diff --git a/docs/Children.json b/docs/Children.json index 175aecba44..c1b3df6f4c 100644 --- a/docs/Children.json +++ b/docs/Children.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * @module Children\n */","meta":{"filename":"gow8xv2nmj77dd1ods2oh.js","lineno":161,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"Children","longname":"module:Children","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/Children.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/Children.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/Children.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/Children","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/Children.ts').default","esPath":"@instructure/ui-prop-types/es/Children","themePath":"packages/ui-prop-types/src/Children.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/Children.ts","id":"Children","title":"Children"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * @module Children\n */","meta":{"filename":"1dmn83983yhv2q00catg7j.js","lineno":161,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"Children","longname":"module:Children","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/Children.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/Children.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/Children.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/Children","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/Children.ts').default","esPath":"@instructure/ui-prop-types/es/Children","themePath":"packages/ui-prop-types/src/Children.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/Children.ts","id":"Children","title":"Children"} \ No newline at end of file diff --git a/docs/DateTime.json b/docs/DateTime.json index ade3884031..2f17021c68 100644 --- a/docs/DateTime.json +++ b/docs/DateTime.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * @deprecated\n * #### DEPRECATION WARNING: Will be removed in v9, which wil include a\n * time library agnostic API.\n * A wrapper for [moment](https://momentjs.com/) utils.\n * @module DateTime\n */","meta":{"filename":"bkqn0cqsilncjxusobkxc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","deprecated":"#### DEPRECATION WARNING: Will be removed in v9, which wil include a\ntime library agnostic API.\nA wrapper for [moment](https://momentjs.com/) utils.","kind":"module","name":"DateTime","longname":"module:DateTime","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/DateTime.ts","extension":".ts","srcPath":"packages/ui-i18n/src/DateTime.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/DateTime.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/DateTime","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/DateTime.ts').default","esPath":"@instructure/ui-i18n/es/DateTime","themePath":"packages/ui-i18n/src/DateTime.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/DateTime.ts","id":"DateTime","title":"DateTime"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * @deprecated\n * #### DEPRECATION WARNING: Will be removed in v9, which wil include a\n * time library agnostic API.\n * A wrapper for [moment](https://momentjs.com/) utils.\n * @module DateTime\n */","meta":{"filename":"s252bgjnqxa0dh1coot773g.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","deprecated":"#### DEPRECATION WARNING: Will be removed in v9, which wil include a\ntime library agnostic API.\nA wrapper for [moment](https://momentjs.com/) utils.","kind":"module","name":"DateTime","longname":"module:DateTime","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/DateTime.ts","extension":".ts","srcPath":"packages/ui-i18n/src/DateTime.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/DateTime.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/DateTime","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/DateTime.ts').default","esPath":"@instructure/ui-i18n/es/DateTime","themePath":"packages/ui-i18n/src/DateTime.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/DateTime.ts","id":"DateTime","title":"DateTime"} \ No newline at end of file diff --git a/docs/FocusRegion.json b/docs/FocusRegion.json index 1748ec76a7..563e32b21b 100644 --- a/docs/FocusRegion.json +++ b/docs/FocusRegion.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Class for focus operations, manages [ScreenReaderFocusRegion](#ScreenReaderFocusRegion)\n * and [KeyboardFocusRegion](#KeyboardFocusRegion) for the given DOM element.\n * - Scoping focus within a given context (DOM node),\n * - Mark active element for focus later\n * - Return focus to the marked element\n * @module FocusRegion\n */","meta":{"filename":"r9qu3kol7fhuf57gn45yh.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nClass for focus operations, manages [ScreenReaderFocusRegion](#ScreenReaderFocusRegion)\nand [KeyboardFocusRegion](#KeyboardFocusRegion) for the given DOM element.\n- Scoping focus within a given context (DOM node),\n- Mark active element for focus later\n- Return focus to the marked element","kind":"module","name":"FocusRegion","longname":"module:FocusRegion","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/FocusRegion.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/FocusRegion.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegion.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/FocusRegion","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/FocusRegion.ts').default","esPath":"@instructure/ui-a11y-utils/es/FocusRegion","themePath":"packages/ui-a11y-utils/src/FocusRegion.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegion.ts","id":"FocusRegion","title":"FocusRegion"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Class for focus operations, manages [ScreenReaderFocusRegion](#ScreenReaderFocusRegion)\n * and [KeyboardFocusRegion](#KeyboardFocusRegion) for the given DOM element.\n * - Scoping focus within a given context (DOM node),\n * - Mark active element for focus later\n * - Return focus to the marked element\n * @module FocusRegion\n */","meta":{"filename":"a1j3gkctjhcn4icm4sauj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nClass for focus operations, manages [ScreenReaderFocusRegion](#ScreenReaderFocusRegion)\nand [KeyboardFocusRegion](#KeyboardFocusRegion) for the given DOM element.\n- Scoping focus within a given context (DOM node),\n- Mark active element for focus later\n- Return focus to the marked element","kind":"module","name":"FocusRegion","longname":"module:FocusRegion","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/FocusRegion.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/FocusRegion.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegion.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/FocusRegion","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/FocusRegion.ts').default","esPath":"@instructure/ui-a11y-utils/es/FocusRegion","themePath":"packages/ui-a11y-utils/src/FocusRegion.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegion.ts","id":"FocusRegion","title":"FocusRegion"} \ No newline at end of file diff --git a/docs/FocusRegionManager.json b/docs/FocusRegionManager.json index 6b3009ac3f..4c1172076e 100644 --- a/docs/FocusRegionManager.json +++ b/docs/FocusRegionManager.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Class for focus operations, manages multiple [FocusRegion](#FocusRegion)s.\n * - Scoping focus within a given context,\n * - Mark active element for focus later\n * - Return focus to the marked element\n * @module FocusManager\n */","meta":{"filename":"vblcl8z19wmqug5fg83fw.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nClass for focus operations, manages multiple [FocusRegion](#FocusRegion)s.\n- Scoping focus within a given context,\n- Mark active element for focus later\n- Return focus to the marked element","kind":"module","name":"FocusManager","longname":"module:FocusManager","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/FocusRegionManager.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/FocusRegionManager.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegionManager.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/FocusRegionManager","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/FocusRegionManager.ts').default","esPath":"@instructure/ui-a11y-utils/es/FocusRegionManager","themePath":"packages/ui-a11y-utils/src/FocusRegionManager.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegionManager.ts","id":"FocusRegionManager","title":"FocusRegionManager"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Class for focus operations, manages multiple [FocusRegion](#FocusRegion)s.\n * - Scoping focus within a given context,\n * - Mark active element for focus later\n * - Return focus to the marked element\n * @module FocusManager\n */","meta":{"filename":"f4zwqtorgfbzwg4n95hemj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nClass for focus operations, manages multiple [FocusRegion](#FocusRegion)s.\n- Scoping focus within a given context,\n- Mark active element for focus later\n- Return focus to the marked element","kind":"module","name":"FocusManager","longname":"module:FocusManager","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/FocusRegionManager.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/FocusRegionManager.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegionManager.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/FocusRegionManager","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/FocusRegionManager.ts').default","esPath":"@instructure/ui-a11y-utils/es/FocusRegionManager","themePath":"packages/ui-a11y-utils/src/FocusRegionManager.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/FocusRegionManager.ts","id":"FocusRegionManager","title":"FocusRegionManager"} \ No newline at end of file diff --git a/docs/FormPropTypes.json b/docs/FormPropTypes.json index 256a347e1e..886dfd1a00 100644 --- a/docs/FormPropTypes.json +++ b/docs/FormPropTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/form\n * ---\n * Custom prop types for React components.\n * @module FormPropTypes\n */","meta":{"filename":"tlloynww0boqyvldfx35yi.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for React components.","kind":"module","name":"FormPropTypes","longname":"module:FormPropTypes","undocumented":false,"category":"utilities/form","relativePath":"packages/ui-form-field/src/FormPropTypes.ts","extension":".ts","srcPath":"packages/ui-form-field/src/FormPropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-form-field/src/FormPropTypes.ts","packageName":"@instructure/ui-form-field","requirePath":"@instructure/ui-form-field/lib/FormPropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-form-field/src/FormPropTypes.ts').default","esPath":"@instructure/ui-form-field/es/FormPropTypes","themePath":"packages/ui-form-field/src/FormPropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-form-field/src/FormPropTypes.ts","id":"FormPropTypes","title":"FormPropTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/form\n * ---\n * Custom prop types for React components.\n * @module FormPropTypes\n */","meta":{"filename":"l8vxyusvwlji92yolp8f3l.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for React components.","kind":"module","name":"FormPropTypes","longname":"module:FormPropTypes","undocumented":false,"category":"utilities/form","relativePath":"packages/ui-form-field/src/FormPropTypes.ts","extension":".ts","srcPath":"packages/ui-form-field/src/FormPropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-form-field/src/FormPropTypes.ts","packageName":"@instructure/ui-form-field","requirePath":"@instructure/ui-form-field/lib/FormPropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-form-field/src/FormPropTypes.ts').default","esPath":"@instructure/ui-form-field/es/FormPropTypes","themePath":"packages/ui-form-field/src/FormPropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-form-field/src/FormPropTypes.ts","id":"FormPropTypes","title":"FormPropTypes"} \ No newline at end of file diff --git a/docs/I18nPropTypes.json b/docs/I18nPropTypes.json index 64a5876040..deb21c2a90 100644 --- a/docs/I18nPropTypes.json +++ b/docs/I18nPropTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * @module I18nPropTypes\n * Custom I18n prop types for React components.\n */","meta":{"filename":"m0lwp32lpqbk6cpzmob89h.js","lineno":12,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"I18nPropTypes\nCustom I18n prop types for React components.","longname":"I18nPropTypes\nCustom I18n prop types for React components.module:","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/I18nPropTypes.ts","extension":".ts","srcPath":"packages/ui-i18n/src/I18nPropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/I18nPropTypes.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/I18nPropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/I18nPropTypes.ts').default","esPath":"@instructure/ui-i18n/es/I18nPropTypes","themePath":"packages/ui-i18n/src/I18nPropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/I18nPropTypes.ts","id":"I18nPropTypes","title":"I18nPropTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * @module I18nPropTypes\n * Custom I18n prop types for React components.\n */","meta":{"filename":"l55wvpauqaevt1egem0tq.js","lineno":12,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"I18nPropTypes\nCustom I18n prop types for React components.","longname":"I18nPropTypes\nCustom I18n prop types for React components.module:","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/I18nPropTypes.ts","extension":".ts","srcPath":"packages/ui-i18n/src/I18nPropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/I18nPropTypes.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/I18nPropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/I18nPropTypes.ts').default","esPath":"@instructure/ui-i18n/es/I18nPropTypes","themePath":"packages/ui-i18n/src/I18nPropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/I18nPropTypes.ts","id":"I18nPropTypes","title":"I18nPropTypes"} \ No newline at end of file diff --git a/docs/KeyboardFocusRegion.json b/docs/KeyboardFocusRegion.json index 3a89db9709..cfac152e12 100644 --- a/docs/KeyboardFocusRegion.json +++ b/docs/KeyboardFocusRegion.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Class for focus operations.\n * - Scoping focus within a given context (DOM node),\n * - Mark active element for focus later\n * - Return focus to the marked element\n * @module KeyboardFocusRegion\n */","meta":{"filename":"xce14qhl86nzz4x1dsd6.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nClass for focus operations.\n- Scoping focus within a given context (DOM node),\n- Mark active element for focus later\n- Return focus to the marked element","kind":"module","name":"KeyboardFocusRegion","longname":"module:KeyboardFocusRegion","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/KeyboardFocusRegion","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/KeyboardFocusRegion.ts').default","esPath":"@instructure/ui-a11y-utils/es/KeyboardFocusRegion","themePath":"packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","id":"KeyboardFocusRegion","title":"KeyboardFocusRegion"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Class for focus operations.\n * - Scoping focus within a given context (DOM node),\n * - Mark active element for focus later\n * - Return focus to the marked element\n * @module KeyboardFocusRegion\n */","meta":{"filename":"2bpzjhlvhhax49ru0exijp.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nClass for focus operations.\n- Scoping focus within a given context (DOM node),\n- Mark active element for focus later\n- Return focus to the marked element","kind":"module","name":"KeyboardFocusRegion","longname":"module:KeyboardFocusRegion","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/KeyboardFocusRegion","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/KeyboardFocusRegion.ts').default","esPath":"@instructure/ui-a11y-utils/es/KeyboardFocusRegion","themePath":"packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/KeyboardFocusRegion.ts","id":"KeyboardFocusRegion","title":"KeyboardFocusRegion"} \ No newline at end of file diff --git a/docs/Locale.json b/docs/Locale.json index cbb5fe142c..38c6f74768 100644 --- a/docs/Locale.json +++ b/docs/Locale.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * Localization utilities\n * @module Locale\n */","meta":{"filename":"sn1nvmhqu1i5wk9dpop2sk.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Localization utilities","kind":"module","name":"Locale","longname":"module:Locale","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/Locale.ts","extension":".ts","srcPath":"packages/ui-i18n/src/Locale.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/Locale.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/Locale","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/Locale.ts').default","esPath":"@instructure/ui-i18n/es/Locale","themePath":"packages/ui-i18n/src/Locale.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/Locale.ts","id":"Locale","title":"Locale"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * Localization utilities\n * @module Locale\n */","meta":{"filename":"8q8mhfhg8brrjamx7svz9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Localization utilities","kind":"module","name":"Locale","longname":"module:Locale","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/Locale.ts","extension":".ts","srcPath":"packages/ui-i18n/src/Locale.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/Locale.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/Locale","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/Locale.ts').default","esPath":"@instructure/ui-i18n/es/Locale","themePath":"packages/ui-i18n/src/Locale.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/Locale.ts","id":"Locale","title":"Locale"} \ No newline at end of file diff --git a/docs/MenuContext.json b/docs/MenuContext.json index d7a2dc03e6..5d4efe0ed3 100644 --- a/docs/MenuContext.json +++ b/docs/MenuContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module MenuContext\n**/","meta":{"filename":"rtw1pn5ixhocofi2ci4hb.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"MenuContext","longname":"module:MenuContext","undocumented":false,"private":true,"relativePath":"packages/ui-menu/src/MenuContext.ts","extension":".ts","srcPath":"packages/ui-menu/src/MenuContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-menu/src/MenuContext.ts","packageName":"@instructure/ui-menu","requirePath":"@instructure/ui-menu/lib/MenuContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-menu/src/MenuContext.ts').default","esPath":"@instructure/ui-menu/es/MenuContext","themePath":"packages/ui-menu/src/MenuContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-menu/src/MenuContext.ts","id":"MenuContext","title":"MenuContext"} \ No newline at end of file +{"comment":"/**\n---\nprivate: true\n---\n@module MenuContext\n**/","meta":{"filename":"om5kjwbabdg2e7qxtgbf9r.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"MenuContext","longname":"module:MenuContext","undocumented":false,"private":true,"relativePath":"packages/ui-menu/src/MenuContext.ts","extension":".ts","srcPath":"packages/ui-menu/src/MenuContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-menu/src/MenuContext.ts","packageName":"@instructure/ui-menu","requirePath":"@instructure/ui-menu/lib/MenuContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-menu/src/MenuContext.ts').default","esPath":"@instructure/ui-menu/es/MenuContext","themePath":"packages/ui-menu/src/MenuContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-menu/src/MenuContext.ts","id":"MenuContext","title":"MenuContext"} \ No newline at end of file diff --git a/docs/PositionPropTypes.json b/docs/PositionPropTypes.json index 44b6fc7699..1f9b125374 100644 --- a/docs/PositionPropTypes.json +++ b/docs/PositionPropTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n * Custom prop types for `ui-position` components.\n * @module PositionPropTypes\n */","meta":{"filename":"rs6ditfear81j0pwfvvffv.js","lineno":25,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for `ui-position` components.","kind":"module","name":"PositionPropTypes","longname":"module:PositionPropTypes","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/PositionPropTypes.ts","extension":".ts","srcPath":"packages/ui-position/src/PositionPropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/PositionPropTypes.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/PositionPropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/PositionPropTypes.ts').default","esPath":"@instructure/ui-position/es/PositionPropTypes","themePath":"packages/ui-position/src/PositionPropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/PositionPropTypes.ts","id":"PositionPropTypes","title":"PositionPropTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n * Custom prop types for `ui-position` components.\n * @module PositionPropTypes\n */","meta":{"filename":"qwm0g4iebf694crmirpr.js","lineno":25,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for `ui-position` components.","kind":"module","name":"PositionPropTypes","longname":"module:PositionPropTypes","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/PositionPropTypes.ts","extension":".ts","srcPath":"packages/ui-position/src/PositionPropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/PositionPropTypes.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/PositionPropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/PositionPropTypes.ts').default","esPath":"@instructure/ui-position/es/PositionPropTypes","themePath":"packages/ui-position/src/PositionPropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/PositionPropTypes.ts","id":"PositionPropTypes","title":"PositionPropTypes"} \ No newline at end of file diff --git a/docs/ResponsivePropTypes.json b/docs/ResponsivePropTypes.json index 16bbc785bf..485e608800 100644 --- a/docs/ResponsivePropTypes.json +++ b/docs/ResponsivePropTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n * Custom prop types for `ui-responsive` components.\n * @module ResponsivePropTypes\n */","meta":{"filename":"5sjsgdebmrevku6srqxjl.js","lineno":29,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for `ui-responsive` components.","kind":"module","name":"ResponsivePropTypes","longname":"module:ResponsivePropTypes","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/ResponsivePropTypes.ts","extension":".ts","srcPath":"packages/ui-responsive/src/ResponsivePropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/ResponsivePropTypes.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/ResponsivePropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/ResponsivePropTypes.ts').default","esPath":"@instructure/ui-responsive/es/ResponsivePropTypes","themePath":"packages/ui-responsive/src/ResponsivePropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/ResponsivePropTypes.ts","id":"ResponsivePropTypes","title":"ResponsivePropTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n * Custom prop types for `ui-responsive` components.\n * @module ResponsivePropTypes\n */","meta":{"filename":"0ns1ja7b3a304q1jzya3zl.js","lineno":29,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for `ui-responsive` components.","kind":"module","name":"ResponsivePropTypes","longname":"module:ResponsivePropTypes","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/ResponsivePropTypes.ts","extension":".ts","srcPath":"packages/ui-responsive/src/ResponsivePropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/ResponsivePropTypes.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/ResponsivePropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/ResponsivePropTypes.ts').default","esPath":"@instructure/ui-responsive/es/ResponsivePropTypes","themePath":"packages/ui-responsive/src/ResponsivePropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/ResponsivePropTypes.ts","id":"ResponsivePropTypes","title":"ResponsivePropTypes"} \ No newline at end of file diff --git a/docs/ScreenReaderFocusRegion.json b/docs/ScreenReaderFocusRegion.json index e2fa7cac8e..558544194a 100644 --- a/docs/ScreenReaderFocusRegion.json +++ b/docs/ScreenReaderFocusRegion.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Utility that hides all DOM elements outside of a specified node. Used,\n * for example, in overlay components where we want to restrict the screen\n * readers to the overlay content.\n * @module ScreenReaderFocusRegion\n */","meta":{"filename":"rx8khhoh5llw60oh0cbpj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nUtility that hides all DOM elements outside of a specified node. Used,\nfor example, in overlay components where we want to restrict the screen\nreaders to the overlay content.","kind":"module","name":"ScreenReaderFocusRegion","longname":"module:ScreenReaderFocusRegion","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/ScreenReaderFocusRegion","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts').default","esPath":"@instructure/ui-a11y-utils/es/ScreenReaderFocusRegion","themePath":"packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","id":"ScreenReaderFocusRegion","title":"ScreenReaderFocusRegion"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Utility that hides all DOM elements outside of a specified node. Used,\n * for example, in overlay components where we want to restrict the screen\n * readers to the overlay content.\n * @module ScreenReaderFocusRegion\n */","meta":{"filename":"j0yix5ugglgs21tr4qtwy.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nUtility that hides all DOM elements outside of a specified node. Used,\nfor example, in overlay components where we want to restrict the screen\nreaders to the overlay content.","kind":"module","name":"ScreenReaderFocusRegion","longname":"module:ScreenReaderFocusRegion","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/ScreenReaderFocusRegion","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts').default","esPath":"@instructure/ui-a11y-utils/es/ScreenReaderFocusRegion","themePath":"packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/ScreenReaderFocusRegion.ts","id":"ScreenReaderFocusRegion","title":"ScreenReaderFocusRegion"} \ No newline at end of file diff --git a/docs/TextDirectionContext.json b/docs/TextDirectionContext.json index 5cb286fcb0..8af6097205 100644 --- a/docs/TextDirectionContext.json +++ b/docs/TextDirectionContext.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * This React context the text direction. I can have 2 values:\n * `ltr`, `rtl`. Its default value is the document's `dir` value, if\n * this is not given then `ltr`. For more info on the values see\n * [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\n * If its set to `ltr` or `rtl` then some InstUI components (e.g.\n * [DrawerLayout](#DrawerLayout) will automatically orient based on its value.\n *\n * @module TextDirectionContext\n */","meta":{"filename":"a6dzzi4a0sis3014zfja9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nThis React context the text direction. I can have 2 values:\n`ltr`, `rtl`. Its default value is the document's `dir` value, if\nthis is not given then `ltr`. For more info on the values see\n[mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\nIf its set to `ltr` or `rtl` then some InstUI components (e.g.\n[DrawerLayout](#DrawerLayout) will automatically orient based on its value.","kind":"module","name":"TextDirectionContext","longname":"module:TextDirectionContext","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/TextDirectionContext.ts","extension":".ts","srcPath":"packages/ui-i18n/src/TextDirectionContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/TextDirectionContext.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/TextDirectionContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/TextDirectionContext.ts').default","esPath":"@instructure/ui-i18n/es/TextDirectionContext","themePath":"packages/ui-i18n/src/TextDirectionContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/TextDirectionContext.ts","id":"TextDirectionContext","title":"TextDirectionContext"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * This React context the text direction. I can have 2 values:\n * `ltr`, `rtl`. Its default value is the document's `dir` value, if\n * this is not given then `ltr`. For more info on the values see\n * [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\n * If its set to `ltr` or `rtl` then some InstUI components (e.g.\n * [DrawerLayout](#DrawerLayout) will automatically orient based on its value.\n *\n * @module TextDirectionContext\n */","meta":{"filename":"3corl2fmauf5e3d3n5onc7.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nThis React context the text direction. I can have 2 values:\n`ltr`, `rtl`. Its default value is the document's `dir` value, if\nthis is not given then `ltr`. For more info on the values see\n[mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\nIf its set to `ltr` or `rtl` then some InstUI components (e.g.\n[DrawerLayout](#DrawerLayout) will automatically orient based on its value.","kind":"module","name":"TextDirectionContext","longname":"module:TextDirectionContext","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/TextDirectionContext.ts","extension":".ts","srcPath":"packages/ui-i18n/src/TextDirectionContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/TextDirectionContext.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/TextDirectionContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/TextDirectionContext.ts').default","esPath":"@instructure/ui-i18n/es/TextDirectionContext","themePath":"packages/ui-i18n/src/TextDirectionContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/TextDirectionContext.ts","id":"TextDirectionContext","title":"TextDirectionContext"} \ No newline at end of file diff --git a/docs/ThemeRegistry.json b/docs/ThemeRegistry.json index 1f3ae8a430..8d009408c5 100644 --- a/docs/ThemeRegistry.json +++ b/docs/ThemeRegistry.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * A global theme registry used for registering theme objects, setting globally available themes\n * and receiving the currently used theme.\n * @module ThemeRegistry\n */","meta":{"filename":"udg9r4cjsjhbp4dqdi25si.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A global theme registry used for registering theme objects, setting globally available themes\nand receiving the currently used theme.","kind":"module","name":"ThemeRegistry","longname":"module:ThemeRegistry","undocumented":false,"category":"utilities/themes","relativePath":"packages/theme-registry/src/ThemeRegistry.ts","extension":".ts","srcPath":"packages/theme-registry/src/ThemeRegistry.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","packageName":"@instructure/theme-registry","requirePath":"@instructure/theme-registry/lib/ThemeRegistry","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/theme-registry/src/ThemeRegistry.ts').default","esPath":"@instructure/theme-registry/es/ThemeRegistry","themePath":"packages/theme-registry/src/ThemeRegistry.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","id":"ThemeRegistry","title":"ThemeRegistry"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * A global theme registry used for registering theme objects, setting globally available themes\n * and receiving the currently used theme.\n * @module ThemeRegistry\n */","meta":{"filename":"64ougdc58sdfgiu894g83o.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A global theme registry used for registering theme objects, setting globally available themes\nand receiving the currently used theme.","kind":"module","name":"ThemeRegistry","longname":"module:ThemeRegistry","undocumented":false,"category":"utilities/themes","relativePath":"packages/theme-registry/src/ThemeRegistry.ts","extension":".ts","srcPath":"packages/theme-registry/src/ThemeRegistry.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","packageName":"@instructure/theme-registry","requirePath":"@instructure/theme-registry/lib/ThemeRegistry","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/theme-registry/src/ThemeRegistry.ts').default","esPath":"@instructure/theme-registry/es/ThemeRegistry","themePath":"packages/theme-registry/src/ThemeRegistry.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","id":"ThemeRegistry","title":"ThemeRegistry"} \ No newline at end of file diff --git a/docs/ThemeablePropTypes.json b/docs/ThemeablePropTypes.json index 67b6411599..df8a07204f 100644 --- a/docs/ThemeablePropTypes.json +++ b/docs/ThemeablePropTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Custom prop types for themeable React components.\n * @module ThemeablePropTypes\n */","meta":{"filename":"zvhf3noa6hf874fs0ccona.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for themeable React components.","kind":"module","name":"ThemeablePropTypes","longname":"module:ThemeablePropTypes","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/ThemeablePropTypes.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/ThemeablePropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/ThemeablePropTypes.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/ThemeablePropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/ThemeablePropTypes.ts').default","esPath":"@instructure/emotion/es/styleUtils/ThemeablePropTypes","themePath":"packages/emotion/src/styleUtils/ThemeablePropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/ThemeablePropTypes.ts","id":"ThemeablePropTypes","title":"ThemeablePropTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Custom prop types for themeable React components.\n * @module ThemeablePropTypes\n */","meta":{"filename":"vxm77nw0ptz1lzgwns69j.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Custom prop types for themeable React components.","kind":"module","name":"ThemeablePropTypes","longname":"module:ThemeablePropTypes","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/ThemeablePropTypes.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/ThemeablePropTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/ThemeablePropTypes.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/ThemeablePropTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/ThemeablePropTypes.ts').default","esPath":"@instructure/emotion/es/styleUtils/ThemeablePropTypes","themePath":"packages/emotion/src/styleUtils/ThemeablePropTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/ThemeablePropTypes.ts","id":"ThemeablePropTypes","title":"ThemeablePropTypes"} \ No newline at end of file diff --git a/docs/TopNavBarContext.json b/docs/TopNavBarContext.json index 840c5a766a..f1ec0665f1 100644 --- a/docs/TopNavBarContext.json +++ b/docs/TopNavBarContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module TopNavBarContext\n**/","meta":{"filename":"ro07c6qpw2gzjf0pdytm7.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"TopNavBarContext","longname":"module:TopNavBarContext","undocumented":false,"private":true,"relativePath":"packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","extension":".ts","srcPath":"packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","packageName":"@instructure/ui-top-nav-bar","requirePath":"@instructure/ui-top-nav-bar/lib/TopNavBar/TopNavBarContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts').default","esPath":"@instructure/ui-top-nav-bar/es/TopNavBar/TopNavBarContext","themePath":"packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","id":"TopNavBarContext","title":"TopNavBarContext"} \ No newline at end of file +{"comment":"/**\n---\nprivate: true\n---\n@module TopNavBarContext\n**/","meta":{"filename":"fngtyt1zzdc8uchiybdxc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"TopNavBarContext","longname":"module:TopNavBarContext","undocumented":false,"private":true,"relativePath":"packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","extension":".ts","srcPath":"packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","packageName":"@instructure/ui-top-nav-bar","requirePath":"@instructure/ui-top-nav-bar/lib/TopNavBar/TopNavBarContext","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts').default","esPath":"@instructure/ui-top-nav-bar/es/TopNavBar/TopNavBarContext","themePath":"packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarContext.ts","id":"TopNavBarContext","title":"TopNavBarContext"} \ No newline at end of file diff --git a/docs/addElementQueryMatchListener.json b/docs/addElementQueryMatchListener.json index e612d722b8..86d260aacf 100644 --- a/docs/addElementQueryMatchListener.json +++ b/docs/addElementQueryMatchListener.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n * Given an object of named queries, listens for changes in the\n * element size and notifies which queries match via a function\n * callback. The callback method is only called when the query\n * matches change, not on all element resizes. (If you are looking\n * to call a method on all element resizes use\n * [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead)\n *\n *\n * This function shares an interface with\n * [addMediaQueryMatchListener](#addMediaQueryMatchListener)\n * so that they can be used interchangeably.\n *\n * The [Responsive](#Responsive) component with the `match` prop\n * set to `element` utilizes this function. This is a low level\n * utility method and, in most cases, [Responsive](#Responsive)\n * should be used instead.\n *\n * ```js-code\n * class MyComponent extends Component {\n * state = {\n * matches: []\n * }\n *\n * _listener = null\n *\n * componentDidMount () {\n * const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n * const el = findDOMNode(this)\n *\n * this._listener = addElementQueryMatchListener(query, el, this.updateMatches)\n * }\n *\n * componentWillUnmount () {\n * if (this._listener) {\n * this._listener.remove()\n * }\n * }\n *\n * updateMatches = (matches) => {\n * this.setState({ matches })\n * }\n * ...\n * }\n * ```\n * @module addElementQueryMatchListener\n * @param {Object} query - object consisting of names and query objects\n * @param {Node|Window|React.ReactElement|React.Component|function} el - a DOM node or a function returning a DOM node\n * @param {function} cb - called with an array of the names of the currently\n * matching queries whenever a matching query changes\n * @returns {function} remove() function to call to remove the listener\n */","meta":{"filename":"7dwh0jp9lfv0s4thk510g9d.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given an object of named queries, listens for changes in the\nelement size and notifies which queries match via a function\ncallback. The callback method is only called when the query\nmatches change, not on all element resizes. (If you are looking\nto call a method on all element resizes use\n[ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead)\n\n\nThis function shares an interface with\n[addMediaQueryMatchListener](#addMediaQueryMatchListener)\nso that they can be used interchangeably.\n\nThe [Responsive](#Responsive) component with the `match` prop\nset to `element` utilizes this function. This is a low level\nutility method and, in most cases, [Responsive](#Responsive)\nshould be used instead.\n\n```js-code\nclass MyComponent extends Component {\n state = {\n matches: []\n }\n\n _listener = null\n\n componentDidMount () {\n const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n const el = findDOMNode(this)\n\n this._listener = addElementQueryMatchListener(query, el, this.updateMatches)\n }\n\n componentWillUnmount () {\n if (this._listener) {\n this._listener.remove()\n }\n }\n\n updateMatches = (matches) => {\n this.setState({ matches })\n }\n ...\n}\n```","kind":"module","name":"addElementQueryMatchListener","params":[{"type":{"names":["Object"]},"description":"object consisting of names and query objects","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"a DOM node or a function returning a DOM node","name":"el"},{"type":{"names":["function"]},"description":"called with an array of the names of the currently\nmatching queries whenever a matching query changes","name":"cb"}],"returns":[{"type":{"names":["function"]},"description":"remove() function to call to remove the listener"}],"longname":"module:addElementQueryMatchListener","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/addElementQueryMatchListener.ts","extension":".ts","srcPath":"packages/ui-responsive/src/addElementQueryMatchListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addElementQueryMatchListener.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/addElementQueryMatchListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/addElementQueryMatchListener.ts').default","esPath":"@instructure/ui-responsive/es/addElementQueryMatchListener","themePath":"packages/ui-responsive/src/addElementQueryMatchListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addElementQueryMatchListener.ts","id":"addElementQueryMatchListener","title":"addElementQueryMatchListener"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n * Given an object of named queries, listens for changes in the\n * element size and notifies which queries match via a function\n * callback. The callback method is only called when the query\n * matches change, not on all element resizes. (If you are looking\n * to call a method on all element resizes use\n * [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead)\n *\n *\n * This function shares an interface with\n * [addMediaQueryMatchListener](#addMediaQueryMatchListener)\n * so that they can be used interchangeably.\n *\n * The [Responsive](#Responsive) component with the `match` prop\n * set to `element` utilizes this function. This is a low level\n * utility method and, in most cases, [Responsive](#Responsive)\n * should be used instead.\n *\n * ```js-code\n * class MyComponent extends Component {\n * state = {\n * matches: []\n * }\n *\n * _listener = null\n *\n * componentDidMount () {\n * const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n * const el = findDOMNode(this)\n *\n * this._listener = addElementQueryMatchListener(query, el, this.updateMatches)\n * }\n *\n * componentWillUnmount () {\n * if (this._listener) {\n * this._listener.remove()\n * }\n * }\n *\n * updateMatches = (matches) => {\n * this.setState({ matches })\n * }\n * ...\n * }\n * ```\n * @module addElementQueryMatchListener\n * @param {Object} query - object consisting of names and query objects\n * @param {Node|Window|React.ReactElement|React.Component|function} el - a DOM node or a function returning a DOM node\n * @param {function} cb - called with an array of the names of the currently\n * matching queries whenever a matching query changes\n * @returns {function} remove() function to call to remove the listener\n */","meta":{"filename":"511sehun2g5ph7ifdkhvvi.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given an object of named queries, listens for changes in the\nelement size and notifies which queries match via a function\ncallback. The callback method is only called when the query\nmatches change, not on all element resizes. (If you are looking\nto call a method on all element resizes use\n[ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) instead)\n\n\nThis function shares an interface with\n[addMediaQueryMatchListener](#addMediaQueryMatchListener)\nso that they can be used interchangeably.\n\nThe [Responsive](#Responsive) component with the `match` prop\nset to `element` utilizes this function. This is a low level\nutility method and, in most cases, [Responsive](#Responsive)\nshould be used instead.\n\n```js-code\nclass MyComponent extends Component {\n state = {\n matches: []\n }\n\n _listener = null\n\n componentDidMount () {\n const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n const el = findDOMNode(this)\n\n this._listener = addElementQueryMatchListener(query, el, this.updateMatches)\n }\n\n componentWillUnmount () {\n if (this._listener) {\n this._listener.remove()\n }\n }\n\n updateMatches = (matches) => {\n this.setState({ matches })\n }\n ...\n}\n```","kind":"module","name":"addElementQueryMatchListener","params":[{"type":{"names":["Object"]},"description":"object consisting of names and query objects","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"a DOM node or a function returning a DOM node","name":"el"},{"type":{"names":["function"]},"description":"called with an array of the names of the currently\nmatching queries whenever a matching query changes","name":"cb"}],"returns":[{"type":{"names":["function"]},"description":"remove() function to call to remove the listener"}],"longname":"module:addElementQueryMatchListener","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/addElementQueryMatchListener.ts","extension":".ts","srcPath":"packages/ui-responsive/src/addElementQueryMatchListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addElementQueryMatchListener.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/addElementQueryMatchListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/addElementQueryMatchListener.ts').default","esPath":"@instructure/ui-responsive/es/addElementQueryMatchListener","themePath":"packages/ui-responsive/src/addElementQueryMatchListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addElementQueryMatchListener.ts","id":"addElementQueryMatchListener","title":"addElementQueryMatchListener"} \ No newline at end of file diff --git a/docs/addEventListener.json b/docs/addEventListener.json index 19ebf9a80e..f72ab482db 100644 --- a/docs/addEventListener.json +++ b/docs/addEventListener.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Wrapper function for DOM addEventListener\n * @module addEventListener\n * @param { Node | Window } el - DOM node which will have the event listener attached\n * @param { string } event - a string specifying the event name ('click', 'focus', etc)\n * @param { React.EventHandler> } handler - function to run when event occurs\n * @param { boolean } capture - should the event be executed in the capturing or bubbling phase\n * @returns {{ remove(): void }} a method to remove the event listener\n */","meta":{"filename":"31nsbbyl2juld2qe4lpmm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Wrapper function for DOM addEventListener","kind":"module","name":"addEventListener","params":[{"type":{"names":["Node","Window"]},"description":"DOM node which will have the event listener attached","name":"el"},{"type":{"names":["string"]},"description":"a string specifying the event name ('click', 'focus', etc)","name":"event"},{"type":{"names":["React.EventHandler.>"]},"description":"function to run when event occurs","name":"handler"},{"type":{"names":["boolean"]},"description":"should the event be executed in the capturing or bubbling phase","name":"capture"}],"returns":[{"type":{"names":["Object"]},"description":"a method to remove the event listener"}],"longname":"module:addEventListener","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/addEventListener.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/addEventListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addEventListener.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/addEventListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/addEventListener.ts').default","esPath":"@instructure/ui-dom-utils/es/addEventListener","themePath":"packages/ui-dom-utils/src/addEventListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addEventListener.ts","id":"addEventListener","title":"addEventListener"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Wrapper function for DOM addEventListener\n * @module addEventListener\n * @param { Node | Window } el - DOM node which will have the event listener attached\n * @param { string } event - a string specifying the event name ('click', 'focus', etc)\n * @param { React.EventHandler> } handler - function to run when event occurs\n * @param { boolean } capture - should the event be executed in the capturing or bubbling phase\n * @returns {{ remove(): void }} a method to remove the event listener\n */","meta":{"filename":"jse8837pg97dz6oq81vbp.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Wrapper function for DOM addEventListener","kind":"module","name":"addEventListener","params":[{"type":{"names":["Node","Window"]},"description":"DOM node which will have the event listener attached","name":"el"},{"type":{"names":["string"]},"description":"a string specifying the event name ('click', 'focus', etc)","name":"event"},{"type":{"names":["React.EventHandler.>"]},"description":"function to run when event occurs","name":"handler"},{"type":{"names":["boolean"]},"description":"should the event be executed in the capturing or bubbling phase","name":"capture"}],"returns":[{"type":{"names":["Object"]},"description":"a method to remove the event listener"}],"longname":"module:addEventListener","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/addEventListener.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/addEventListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addEventListener.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/addEventListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/addEventListener.ts').default","esPath":"@instructure/ui-dom-utils/es/addEventListener","themePath":"packages/ui-dom-utils/src/addEventListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addEventListener.ts","id":"addEventListener","title":"addEventListener"} \ No newline at end of file diff --git a/docs/addMediaQueryMatchListener.json b/docs/addMediaQueryMatchListener.json index 2cd8e498d3..509cafc262 100644 --- a/docs/addMediaQueryMatchListener.json +++ b/docs/addMediaQueryMatchListener.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n * Given an object of named queries, listens for changes in the\n * window size and notifies which queries match via a function\n * callback. The callback method is only called when the query\n * matches change, not on all window resizes.\n *\n * This function shares an interface with\n * [addElementQueryMatchListener](#addElementQueryMatchListener)\n * so that they can be used interchangeably.\n *\n * The [Responsive](#Responsive) component with the `match` prop\n * set to `media` utilizes this function. This is a low level utility\n * method and, in most cases, [Responsive](#Responsive) should be\n * used instead.\n *\n * ```js-code\n * class MyComponent extends Component {\n * state = {\n * matches: []\n * }\n *\n * _listener = null\n *\n * componentDidMount () {\n * const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n * const el = findDOMNode(this)\n *\n * this._listener = addMediaQueryMatchListener(query, el, this.updateMatches)\n * }\n *\n * componentWillUnmount () {\n * if (this._listener) {\n * this._listener.remove()\n * }\n * }\n *\n * updateMatches = (matches) => {\n * this.setState({ matches })\n * }\n * ...\n * }\n * ```\n * @module addMediaQueryMatchListener\n * @param {Object} query - object consisting of names and query objects\n * @param {Node|Window|React.ReactElement|React.Component|function} el - a DOM node or a function returning a DOM node\n * @param {function} cb - called with an array of the names of the currently matching queries whenever a matching query changes\n * @param {object} matchMedia - called with an array of the names of the currently matching queries whenever a matching query changes\n * @returns {function} remove() function to call to remove the listener\n */","meta":{"filename":"8nkb158ndaw4xmfgharfb.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given an object of named queries, listens for changes in the\nwindow size and notifies which queries match via a function\ncallback. The callback method is only called when the query\nmatches change, not on all window resizes.\n\nThis function shares an interface with\n[addElementQueryMatchListener](#addElementQueryMatchListener)\nso that they can be used interchangeably.\n\nThe [Responsive](#Responsive) component with the `match` prop\nset to `media` utilizes this function. This is a low level utility\nmethod and, in most cases, [Responsive](#Responsive) should be\nused instead.\n\n```js-code\nclass MyComponent extends Component {\n state = {\n matches: []\n }\n\n _listener = null\n\n componentDidMount () {\n const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n const el = findDOMNode(this)\n\n this._listener = addMediaQueryMatchListener(query, el, this.updateMatches)\n }\n\n componentWillUnmount () {\n if (this._listener) {\n this._listener.remove()\n }\n }\n\n updateMatches = (matches) => {\n this.setState({ matches })\n }\n ...\n}\n```","kind":"module","name":"addMediaQueryMatchListener","params":[{"type":{"names":["Object"]},"description":"object consisting of names and query objects","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"a DOM node or a function returning a DOM node","name":"el"},{"type":{"names":["function"]},"description":"called with an array of the names of the currently matching queries whenever a matching query changes","name":"cb"},{"type":{"names":["object"]},"description":"called with an array of the names of the currently matching queries whenever a matching query changes","name":"matchMedia"}],"returns":[{"type":{"names":["function"]},"description":"remove() function to call to remove the listener"}],"longname":"module:addMediaQueryMatchListener","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/addMediaQueryMatchListener.ts","extension":".ts","srcPath":"packages/ui-responsive/src/addMediaQueryMatchListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addMediaQueryMatchListener.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/addMediaQueryMatchListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/addMediaQueryMatchListener.ts').default","esPath":"@instructure/ui-responsive/es/addMediaQueryMatchListener","themePath":"packages/ui-responsive/src/addMediaQueryMatchListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addMediaQueryMatchListener.ts","id":"addMediaQueryMatchListener","title":"addMediaQueryMatchListener"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n * Given an object of named queries, listens for changes in the\n * window size and notifies which queries match via a function\n * callback. The callback method is only called when the query\n * matches change, not on all window resizes.\n *\n * This function shares an interface with\n * [addElementQueryMatchListener](#addElementQueryMatchListener)\n * so that they can be used interchangeably.\n *\n * The [Responsive](#Responsive) component with the `match` prop\n * set to `media` utilizes this function. This is a low level utility\n * method and, in most cases, [Responsive](#Responsive) should be\n * used instead.\n *\n * ```js-code\n * class MyComponent extends Component {\n * state = {\n * matches: []\n * }\n *\n * _listener = null\n *\n * componentDidMount () {\n * const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n * const el = findDOMNode(this)\n *\n * this._listener = addMediaQueryMatchListener(query, el, this.updateMatches)\n * }\n *\n * componentWillUnmount () {\n * if (this._listener) {\n * this._listener.remove()\n * }\n * }\n *\n * updateMatches = (matches) => {\n * this.setState({ matches })\n * }\n * ...\n * }\n * ```\n * @module addMediaQueryMatchListener\n * @param {Object} query - object consisting of names and query objects\n * @param {Node|Window|React.ReactElement|React.Component|function} el - a DOM node or a function returning a DOM node\n * @param {function} cb - called with an array of the names of the currently matching queries whenever a matching query changes\n * @param {object} matchMedia - called with an array of the names of the currently matching queries whenever a matching query changes\n * @returns {function} remove() function to call to remove the listener\n */","meta":{"filename":"ey2ai0eiilvtv4e22h08p.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given an object of named queries, listens for changes in the\nwindow size and notifies which queries match via a function\ncallback. The callback method is only called when the query\nmatches change, not on all window resizes.\n\nThis function shares an interface with\n[addElementQueryMatchListener](#addElementQueryMatchListener)\nso that they can be used interchangeably.\n\nThe [Responsive](#Responsive) component with the `match` prop\nset to `media` utilizes this function. This is a low level utility\nmethod and, in most cases, [Responsive](#Responsive) should be\nused instead.\n\n```js-code\nclass MyComponent extends Component {\n state = {\n matches: []\n }\n\n _listener = null\n\n componentDidMount () {\n const query = {myFirstQuery: { minWidth: 100 }, mySecondQuery: { maxHeight: '30rem'}}\n const el = findDOMNode(this)\n\n this._listener = addMediaQueryMatchListener(query, el, this.updateMatches)\n }\n\n componentWillUnmount () {\n if (this._listener) {\n this._listener.remove()\n }\n }\n\n updateMatches = (matches) => {\n this.setState({ matches })\n }\n ...\n}\n```","kind":"module","name":"addMediaQueryMatchListener","params":[{"type":{"names":["Object"]},"description":"object consisting of names and query objects","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"a DOM node or a function returning a DOM node","name":"el"},{"type":{"names":["function"]},"description":"called with an array of the names of the currently matching queries whenever a matching query changes","name":"cb"},{"type":{"names":["object"]},"description":"called with an array of the names of the currently matching queries whenever a matching query changes","name":"matchMedia"}],"returns":[{"type":{"names":["function"]},"description":"remove() function to call to remove the listener"}],"longname":"module:addMediaQueryMatchListener","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/addMediaQueryMatchListener.ts","extension":".ts","srcPath":"packages/ui-responsive/src/addMediaQueryMatchListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addMediaQueryMatchListener.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/addMediaQueryMatchListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/addMediaQueryMatchListener.ts').default","esPath":"@instructure/ui-responsive/es/addMediaQueryMatchListener","themePath":"packages/ui-responsive/src/addMediaQueryMatchListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/addMediaQueryMatchListener.ts","id":"addMediaQueryMatchListener","title":"addMediaQueryMatchListener"} \ No newline at end of file diff --git a/docs/addPositionChangeListener.json b/docs/addPositionChangeListener.json index 43b03e3a93..fd328b9e1a 100644 --- a/docs/addPositionChangeListener.json +++ b/docs/addPositionChangeListener.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Adds a listener to an element and calls a specified handler\n * function whenever the position changes\n * @module\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @param {function} handler - function to run if the position has changed\n * @returns {function} remove - cancel the listener and no longer execute the handler function\n */","meta":{"filename":"2gm2ayltfppf5awhyzfcph.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Adds a listener to an element and calls a specified handler\nfunction whenever the position changes","kind":"module","name":"2gm2ayltfppf5awhyzfcph","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"},{"type":{"names":["function"]},"description":"function to run if the position has changed","name":"handler"}],"returns":[{"type":{"names":["function"]},"description":"remove - cancel the listener and no longer execute the handler function"}],"longname":"module:2gm2ayltfppf5awhyzfcph","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/addPositionChangeListener.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/addPositionChangeListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addPositionChangeListener.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/addPositionChangeListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/addPositionChangeListener.ts').default","esPath":"@instructure/ui-dom-utils/es/addPositionChangeListener","themePath":"packages/ui-dom-utils/src/addPositionChangeListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addPositionChangeListener.ts","id":"addPositionChangeListener","title":"addPositionChangeListener"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Adds a listener to an element and calls a specified handler\n * function whenever the position changes\n * @module\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @param {function} handler - function to run if the position has changed\n * @returns {function} remove - cancel the listener and no longer execute the handler function\n */","meta":{"filename":"kt9jlbyv6g5zud0w9qom.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Adds a listener to an element and calls a specified handler\nfunction whenever the position changes","kind":"module","name":"kt9jlbyv6g5zud0w9qom","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"},{"type":{"names":["function"]},"description":"function to run if the position has changed","name":"handler"}],"returns":[{"type":{"names":["function"]},"description":"remove - cancel the listener and no longer execute the handler function"}],"longname":"module:kt9jlbyv6g5zud0w9qom","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/addPositionChangeListener.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/addPositionChangeListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addPositionChangeListener.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/addPositionChangeListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/addPositionChangeListener.ts').default","esPath":"@instructure/ui-dom-utils/es/addPositionChangeListener","themePath":"packages/ui-dom-utils/src/addPositionChangeListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/addPositionChangeListener.ts","id":"addPositionChangeListener","title":"addPositionChangeListener"} \ No newline at end of file diff --git a/docs/alpha.json b/docs/alpha.json index a4a315e132..6f183f345f 100644 --- a/docs/alpha.json +++ b/docs/alpha.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Adjust the alpha transparency of a color\n * @module alpha\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"p1g0om75mlqr0ze2e3min.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Adjust the alpha transparency of a color","kind":"module","name":"alpha","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:alpha","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/alpha.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/alpha.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/alpha","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/alpha.ts').default","esPath":"@instructure/ui-color-utils/es/alpha","themePath":"packages/ui-color-utils/src/alpha.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","id":"alpha","title":"alpha"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Adjust the alpha transparency of a color\n * @module alpha\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"rp0p50nq9mdp1bu6s8cnv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Adjust the alpha transparency of a color","kind":"module","name":"alpha","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:alpha","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/alpha.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/alpha.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/alpha","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/alpha.ts').default","esPath":"@instructure/ui-color-utils/es/alpha","themePath":"packages/ui-color-utils/src/alpha.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/alpha.ts","id":"alpha","title":"alpha"} \ No newline at end of file diff --git a/docs/calculateElementPosition.json b/docs/calculateElementPosition.json index 377846a5a9..6bf3576f28 100644 --- a/docs/calculateElementPosition.json +++ b/docs/calculateElementPosition.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n *\n * Calculate the coordinates to attach an element\n * to a designated target with specified constraints\n * @module\n * @param {ReactComponent|DomNode} el - component or DOM node\n * @param {DomNode} target - the target DOM node\n * @param {Object} options - constraints for the positioning\n * @param {string} options.placement - designates where the element will be attached\n * ('top', 'bottom', 'left', 'right', 'top left' etc.)\n * @param {DomNode} options.container - DOM node where the element is contained\n * @param {boolean} options.over - whether or not you want the element to position over the target\n * @param {string} options.constrain - if the element should be constrained to 'window',\n * 'scroll-parent', 'parent', or 'none'\n * @param {string|number} options.offsetX - the horizontal offset for the positioned element\n * @param {string|number} options.offsetY - the vertical offset for the positioned element\n * @returns {Object} object containing style with the calculated position in the 'transform'\n * property\n */","meta":{"filename":"5cs4djacfuwh4pjxfnlqan.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nCalculate the coordinates to attach an element\nto a designated target with specified constraints","kind":"module","name":"5cs4djacfuwh4pjxfnlqan","params":[{"type":{"names":["ReactComponent","DomNode"]},"description":"component or DOM node","name":"el"},{"type":{"names":["DomNode"]},"description":"the target DOM node","name":"target"},{"type":{"names":["Object"]},"description":"constraints for the positioning","name":"options"},{"type":{"names":["string"]},"description":"designates where the element will be attached\n ('top', 'bottom', 'left', 'right', 'top left' etc.)","name":"options.placement"},{"type":{"names":["DomNode"]},"description":"DOM node where the element is contained","name":"options.container"},{"type":{"names":["boolean"]},"description":"whether or not you want the element to position over the target","name":"options.over"},{"type":{"names":["string"]},"description":"if the element should be constrained to 'window',\n 'scroll-parent', 'parent', or 'none'","name":"options.constrain"},{"type":{"names":["string","number"]},"description":"the horizontal offset for the positioned element","name":"options.offsetX"},{"type":{"names":["string","number"]},"description":"the vertical offset for the positioned element","name":"options.offsetY"}],"returns":[{"type":{"names":["Object"]},"description":"object containing style with the calculated position in the 'transform'\n property"}],"longname":"module:5cs4djacfuwh4pjxfnlqan","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/calculateElementPosition.ts","extension":".ts","srcPath":"packages/ui-position/src/calculateElementPosition.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/calculateElementPosition.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/calculateElementPosition","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/calculateElementPosition.ts').default","esPath":"@instructure/ui-position/es/calculateElementPosition","themePath":"packages/ui-position/src/calculateElementPosition.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/calculateElementPosition.ts","id":"calculateElementPosition","title":"calculateElementPosition"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n *\n * Calculate the coordinates to attach an element\n * to a designated target with specified constraints\n * @module\n * @param {ReactComponent|DomNode} el - component or DOM node\n * @param {DomNode} target - the target DOM node\n * @param {Object} options - constraints for the positioning\n * @param {string} options.placement - designates where the element will be attached\n * ('top', 'bottom', 'left', 'right', 'top left' etc.)\n * @param {DomNode} options.container - DOM node where the element is contained\n * @param {boolean} options.over - whether or not you want the element to position over the target\n * @param {string} options.constrain - if the element should be constrained to 'window',\n * 'scroll-parent', 'parent', or 'none'\n * @param {string|number} options.offsetX - the horizontal offset for the positioned element\n * @param {string|number} options.offsetY - the vertical offset for the positioned element\n * @returns {Object} object containing style with the calculated position in the 'transform'\n * property\n */","meta":{"filename":"oed9l2bebukzhlxpaz51.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nCalculate the coordinates to attach an element\nto a designated target with specified constraints","kind":"module","name":"oed9l2bebukzhlxpaz51","params":[{"type":{"names":["ReactComponent","DomNode"]},"description":"component or DOM node","name":"el"},{"type":{"names":["DomNode"]},"description":"the target DOM node","name":"target"},{"type":{"names":["Object"]},"description":"constraints for the positioning","name":"options"},{"type":{"names":["string"]},"description":"designates where the element will be attached\n ('top', 'bottom', 'left', 'right', 'top left' etc.)","name":"options.placement"},{"type":{"names":["DomNode"]},"description":"DOM node where the element is contained","name":"options.container"},{"type":{"names":["boolean"]},"description":"whether or not you want the element to position over the target","name":"options.over"},{"type":{"names":["string"]},"description":"if the element should be constrained to 'window',\n 'scroll-parent', 'parent', or 'none'","name":"options.constrain"},{"type":{"names":["string","number"]},"description":"the horizontal offset for the positioned element","name":"options.offsetX"},{"type":{"names":["string","number"]},"description":"the vertical offset for the positioned element","name":"options.offsetY"}],"returns":[{"type":{"names":["Object"]},"description":"object containing style with the calculated position in the 'transform'\n property"}],"longname":"module:oed9l2bebukzhlxpaz51","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/calculateElementPosition.ts","extension":".ts","srcPath":"packages/ui-position/src/calculateElementPosition.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/calculateElementPosition.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/calculateElementPosition","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/calculateElementPosition.ts').default","esPath":"@instructure/ui-position/es/calculateElementPosition","themePath":"packages/ui-position/src/calculateElementPosition.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/calculateElementPosition.ts","id":"calculateElementPosition","title":"calculateElementPosition"} \ No newline at end of file diff --git a/docs/callRenderProp.json b/docs/callRenderProp.json index 2b39ba07ae..f0292a769e 100644 --- a/docs/callRenderProp.json +++ b/docs/callRenderProp.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Evaluate a provided value to create a renderable React element.\n * @module callRenderProp\n * @param value\n * @param props\n */","meta":{"filename":"0kcvu4ixjsgxnhi6m1ct3.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Evaluate a provided value to create a renderable React element.","kind":"module","name":"callRenderProp","params":[{"name":"value"},{"name":"props"}],"longname":"module:callRenderProp","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/callRenderProp.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/callRenderProp.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/callRenderProp.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/callRenderProp","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/callRenderProp.ts').default","esPath":"@instructure/ui-react-utils/es/callRenderProp","themePath":"packages/ui-react-utils/src/callRenderProp.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/callRenderProp.ts","id":"callRenderProp","title":"callRenderProp"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Evaluate a provided value to create a renderable React element.\n * @module callRenderProp\n * @param value\n * @param props\n */","meta":{"filename":"cggbeb8t748xpnkvrmb2t.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Evaluate a provided value to create a renderable React element.","kind":"module","name":"callRenderProp","params":[{"name":"value"},{"name":"props"}],"longname":"module:callRenderProp","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/callRenderProp.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/callRenderProp.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/callRenderProp.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/callRenderProp","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/callRenderProp.ts').default","esPath":"@instructure/ui-react-utils/es/callRenderProp","themePath":"packages/ui-react-utils/src/callRenderProp.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/callRenderProp.ts","id":"callRenderProp","title":"callRenderProp"} \ No newline at end of file diff --git a/docs/camelize.json b/docs/camelize.json index 37a20c0ca5..c2c0aba119 100644 --- a/docs/camelize.json +++ b/docs/camelize.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a hyphenated string to camel case\n *\n * Example inputs:\n * - 'foo-bar'\n * - 'baz-qux'\n *\n * Example outputs:\n * - 'fooBar'\n * - 'bazQux'\n *\n * @module camelize\n * @param {String} str\n * @returns {String} Returns camel cased string\n */","meta":{"filename":"phy8ghx2p5svf87zv6qvsf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a hyphenated string to camel case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'fooBar'\n - 'bazQux'","kind":"module","name":"camelize","params":[{"type":{"names":["String"]},"name":"str"}],"returns":[{"type":{"names":["String"]},"description":"Returns camel cased string"}],"longname":"module:camelize","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/camelize.ts","extension":".ts","srcPath":"packages/ui-utils/src/camelize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/camelize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/camelize.ts').default","esPath":"@instructure/ui-utils/es/camelize","themePath":"packages/ui-utils/src/camelize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","id":"camelize","title":"camelize"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a hyphenated string to camel case\n *\n * Example inputs:\n * - 'foo-bar'\n * - 'baz-qux'\n *\n * Example outputs:\n * - 'fooBar'\n * - 'bazQux'\n *\n * @module camelize\n * @param {String} str\n * @returns {String} Returns camel cased string\n */","meta":{"filename":"vp9av4ym9rhrkj5f1jp2i.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a hyphenated string to camel case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'fooBar'\n - 'bazQux'","kind":"module","name":"camelize","params":[{"type":{"names":["String"]},"name":"str"}],"returns":[{"type":{"names":["String"]},"description":"Returns camel cased string"}],"longname":"module:camelize","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/camelize.ts","extension":".ts","srcPath":"packages/ui-utils/src/camelize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/camelize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/camelize.ts').default","esPath":"@instructure/ui-utils/es/camelize","themePath":"packages/ui-utils/src/camelize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/camelize.ts","id":"camelize","title":"camelize"} \ No newline at end of file diff --git a/docs/canUseDOM.json b/docs/canUseDOM.json index 18b72da973..dfc8d41acc 100644 --- a/docs/canUseDOM.json +++ b/docs/canUseDOM.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Performs simple test to determine if DOM can be accessed\n * @module\n * @returns {boolean} whether the dom can be used\n */","meta":{"filename":"m4xkoh0mt6xxir4yjiunh.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"m4xkoh0mt6xxir4yjiunh","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:m4xkoh0mt6xxir4yjiunh","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/canUseDOM.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/canUseDOM.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/canUseDOM.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/canUseDOM","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/canUseDOM.ts').default","esPath":"@instructure/ui-dom-utils/es/canUseDOM","themePath":"packages/ui-dom-utils/src/canUseDOM.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/canUseDOM.ts","id":"canUseDOM","title":"canUseDOM"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Performs simple test to determine if DOM can be accessed\n * @module\n * @returns {boolean} whether the dom can be used\n */","meta":{"filename":"4o1urqcvhysa3pxxkddds.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"4o1urqcvhysa3pxxkddds","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:4o1urqcvhysa3pxxkddds","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/canUseDOM.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/canUseDOM.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/canUseDOM.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/canUseDOM","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/canUseDOM.ts').default","esPath":"@instructure/ui-dom-utils/es/canUseDOM","themePath":"packages/ui-dom-utils/src/canUseDOM.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/canUseDOM.ts","id":"canUseDOM","title":"canUseDOM"} \ No newline at end of file diff --git a/docs/capitalizeFirstLetter.json b/docs/capitalizeFirstLetter.json index 95411a24d9..bc8689b0a6 100644 --- a/docs/capitalizeFirstLetter.json +++ b/docs/capitalizeFirstLetter.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Capitalize the first letter in a string\n * @module capitalizeFirstLetter\n * @param {String} str\n */","meta":{"filename":"sp7m05lykhnq8v80tedx.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Capitalize the first letter in a string","kind":"module","name":"capitalizeFirstLetter","params":[{"type":{"names":["String"]},"name":"str"}],"longname":"module:capitalizeFirstLetter","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","extension":".ts","srcPath":"packages/ui-utils/src/capitalizeFirstLetter.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/capitalizeFirstLetter","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/capitalizeFirstLetter.ts').default","esPath":"@instructure/ui-utils/es/capitalizeFirstLetter","themePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","id":"capitalizeFirstLetter","title":"capitalizeFirstLetter"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Capitalize the first letter in a string\n * @module capitalizeFirstLetter\n * @param {String} str\n */","meta":{"filename":"wtyt7ge1g6sf61rdf4x4l5.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Capitalize the first letter in a string","kind":"module","name":"capitalizeFirstLetter","params":[{"type":{"names":["String"]},"name":"str"}],"longname":"module:capitalizeFirstLetter","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","extension":".ts","srcPath":"packages/ui-utils/src/capitalizeFirstLetter.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/capitalizeFirstLetter","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/capitalizeFirstLetter.ts').default","esPath":"@instructure/ui-utils/es/capitalizeFirstLetter","themePath":"packages/ui-utils/src/capitalizeFirstLetter.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/capitalizeFirstLetter.ts","id":"capitalizeFirstLetter","title":"capitalizeFirstLetter"} \ No newline at end of file diff --git a/docs/childrenOrValue.json b/docs/childrenOrValue.json index db7963577c..30651d57e7 100644 --- a/docs/childrenOrValue.json +++ b/docs/childrenOrValue.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that either value is provided as a prop if as=\"input\", and children\n * if provided otherwise\n *\n * ```js-code\n * import { childrenOrValue } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * children: childrenOrValue,\n * value: childrenOrValue\n * }\n * ...\n * ```\n * @module childrenOrValue\n */","meta":{"filename":"yp9nfj0eytsovc00ul8rt9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that either value is provided as a prop if as=\"input\", and children\nif provided otherwise\n\n```js-code\n import { childrenOrValue } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n children: childrenOrValue,\n value: childrenOrValue\n }\n ...\n```","kind":"module","name":"childrenOrValue","longname":"module:childrenOrValue","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/childrenOrValue.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/childrenOrValue.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/childrenOrValue.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/childrenOrValue","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/childrenOrValue.ts').default","esPath":"@instructure/ui-prop-types/es/childrenOrValue","themePath":"packages/ui-prop-types/src/childrenOrValue.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/childrenOrValue.ts","id":"childrenOrValue","title":"childrenOrValue"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that either value is provided as a prop if as=\"input\", and children\n * if provided otherwise\n *\n * ```js-code\n * import { childrenOrValue } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * children: childrenOrValue,\n * value: childrenOrValue\n * }\n * ...\n * ```\n * @module childrenOrValue\n */","meta":{"filename":"71ugmujkz9mw1l4n2m7xu.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that either value is provided as a prop if as=\"input\", and children\nif provided otherwise\n\n```js-code\n import { childrenOrValue } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n children: childrenOrValue,\n value: childrenOrValue\n }\n ...\n```","kind":"module","name":"childrenOrValue","longname":"module:childrenOrValue","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/childrenOrValue.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/childrenOrValue.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/childrenOrValue.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/childrenOrValue","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/childrenOrValue.ts').default","esPath":"@instructure/ui-prop-types/es/childrenOrValue","themePath":"packages/ui-prop-types/src/childrenOrValue.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/childrenOrValue.ts","id":"childrenOrValue","title":"childrenOrValue"} \ No newline at end of file diff --git a/docs/cloneArray.json b/docs/cloneArray.json index 99836f3ea9..c6e430cc61 100644 --- a/docs/cloneArray.json +++ b/docs/cloneArray.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Deep clones an array with sub arrays\n * @module cloneArray\n * @param {Array} arr\n * @returns {Array} Returns a copy of the array\n */","meta":{"filename":"gpvmspj1hpjw4iqritmxkl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deep clones an array with sub arrays","kind":"module","name":"cloneArray","params":[{"type":{"names":["Array"]},"name":"arr"}],"returns":[{"type":{"names":["Array"]},"description":"Returns a copy of the array"}],"longname":"module:cloneArray","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/cloneArray.ts","extension":".ts","srcPath":"packages/ui-utils/src/cloneArray.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/cloneArray.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/cloneArray","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/cloneArray.ts').default","esPath":"@instructure/ui-utils/es/cloneArray","themePath":"packages/ui-utils/src/cloneArray.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/cloneArray.ts","id":"cloneArray","title":"cloneArray"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Deep clones an array with sub arrays\n * @module cloneArray\n * @param {Array} arr\n * @returns {Array} Returns a copy of the array\n */","meta":{"filename":"3k4kt4dbex9rc6jjlwbgoe.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deep clones an array with sub arrays","kind":"module","name":"cloneArray","params":[{"type":{"names":["Array"]},"name":"arr"}],"returns":[{"type":{"names":["Array"]},"description":"Returns a copy of the array"}],"longname":"module:cloneArray","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/cloneArray.ts","extension":".ts","srcPath":"packages/ui-utils/src/cloneArray.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/cloneArray.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/cloneArray","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/cloneArray.ts').default","esPath":"@instructure/ui-utils/es/cloneArray","themePath":"packages/ui-utils/src/cloneArray.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/cloneArray.ts","id":"cloneArray","title":"cloneArray"} \ No newline at end of file diff --git a/docs/contains.json b/docs/contains.json index c142b6fb78..fc69c98315 100644 --- a/docs/contains.json +++ b/docs/contains.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element contains another DOM node\n * @module containsWithDOM\n * @param { Node | Window | React.ReactElement | function | null } context - component or DOM node\n * @param { Node | Window | React.ReactElement | function | null } el - component or DOM node which we want to determine if contained within the context\n * @returns { boolean } if the element is contained within the context\n */","meta":{"filename":"stgklzoyyj6wporeu0xr8.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element contains another DOM node","kind":"module","name":"containsWithDOM","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"description":"component or DOM node","name":"context"},{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"description":"component or DOM node which we want to determine if contained within the context","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is contained within the context"}],"longname":"module:containsWithDOM","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/contains.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/contains.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/contains.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/contains","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/contains.ts').default","esPath":"@instructure/ui-dom-utils/es/contains","themePath":"packages/ui-dom-utils/src/contains.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/contains.ts","id":"contains","title":"contains"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element contains another DOM node\n * @module containsWithDOM\n * @param { Node | Window | React.ReactElement | function | null } context - component or DOM node\n * @param { Node | Window | React.ReactElement | function | null } el - component or DOM node which we want to determine if contained within the context\n * @returns { boolean } if the element is contained within the context\n */","meta":{"filename":"ytoydt51mu80rd890qocfl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element contains another DOM node","kind":"module","name":"containsWithDOM","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"description":"component or DOM node","name":"context"},{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"description":"component or DOM node which we want to determine if contained within the context","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is contained within the context"}],"longname":"module:containsWithDOM","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/contains.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/contains.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/contains.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/contains","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/contains.ts').default","esPath":"@instructure/ui-dom-utils/es/contains","themePath":"packages/ui-dom-utils/src/contains.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/contains.ts","id":"contains","title":"contains"} \ No newline at end of file diff --git a/docs/containsActiveElement.json b/docs/containsActiveElement.json index 3261e49b38..1ca48117e8 100644 --- a/docs/containsActiveElement.json +++ b/docs/containsActiveElement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element contains the active element\n * @module containsActiveElement\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {boolean} if the element contains the active element\n */","meta":{"filename":"3l0zdqgzzdc1u54wtno3mi.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element contains the active element","kind":"module","name":"containsActiveElement","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element contains the active element"}],"longname":"module:containsActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/containsActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/containsActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/containsActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/containsActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/containsActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/containsActiveElement","themePath":"packages/ui-dom-utils/src/containsActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/containsActiveElement.ts","id":"containsActiveElement","title":"containsActiveElement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element contains the active element\n * @module containsActiveElement\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {boolean} if the element contains the active element\n */","meta":{"filename":"sjb8htqtb6qjanw2c05jyk.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element contains the active element","kind":"module","name":"containsActiveElement","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element contains the active element"}],"longname":"module:containsActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/containsActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/containsActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/containsActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/containsActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/containsActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/containsActiveElement","themePath":"packages/ui-dom-utils/src/containsActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/containsActiveElement.ts","id":"containsActiveElement","title":"containsActiveElement"} \ No newline at end of file diff --git a/docs/contrast.json b/docs/contrast.json index d7c2ef1f0a..3911826f95 100644 --- a/docs/contrast.json +++ b/docs/contrast.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * check the contrast ratio of 2 colors. Optionally number of decimal places can be added\n * @module contrast\n * @param {String} color1\n * @param {String} color2\n * @param {Number} decimalPlaces\n * @returns {Number} color contrast ratio\n */","meta":{"filename":"i0whnpfxhlwjb0ycjc07e.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"check the contrast ratio of 2 colors. Optionally number of decimal places can be added","kind":"module","name":"contrast","params":[{"type":{"names":["String"]},"name":"color1"},{"type":{"names":["String"]},"name":"color2"},{"type":{"names":["Number"]},"name":"decimalPlaces"}],"returns":[{"type":{"names":["Number"]},"description":"color contrast ratio"}],"longname":"module:contrast","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/contrast.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/contrast.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrast.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/contrast","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/contrast.ts').default","esPath":"@instructure/ui-color-utils/es/contrast","themePath":"packages/ui-color-utils/src/contrast.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrast.ts","id":"contrast","title":"contrast"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * check the contrast ratio of 2 colors. Optionally number of decimal places can be added\n * @module contrast\n * @param {String} color1\n * @param {String} color2\n * @param {Number} decimalPlaces\n * @returns {Number} color contrast ratio\n */","meta":{"filename":"f0iov7anzafdv83jfe1cqa.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"check the contrast ratio of 2 colors. Optionally number of decimal places can be added","kind":"module","name":"contrast","params":[{"type":{"names":["String"]},"name":"color1"},{"type":{"names":["String"]},"name":"color2"},{"type":{"names":["Number"]},"name":"decimalPlaces"}],"returns":[{"type":{"names":["Number"]},"description":"color contrast ratio"}],"longname":"module:contrast","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/contrast.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/contrast.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrast.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/contrast","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/contrast.ts').default","esPath":"@instructure/ui-color-utils/es/contrast","themePath":"packages/ui-color-utils/src/contrast.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrast.ts","id":"contrast","title":"contrast"} \ No newline at end of file diff --git a/docs/controllable.json b/docs/controllable.json index 6e4173b5de..201cf6ff94 100644 --- a/docs/controllable.json +++ b/docs/controllable.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Ensure that a corresponding handler function is provided for the given prop if the\n * component does not manage its own state.\n *\n * ```js-code\n * import { controllable } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * selected: controllable(PropTypes.bool, 'onSelect', 'defaultSelected'),\n * onSelect: PropTypes.func,\n * defaultSelected: PropTypes.bool\n * }\n * ...\n * ```\n *\n * This will throw an error if the 'selected' prop is supplied without a corresponding\n * 'onSelect' handler and will recommend using 'defaultSelected' instead.\n * @module controllable\n * @param {function} checkType - validates the prop type. Returns null if valid, error otherwise\n * @param {string} handlerName - name of the handler function\n * @param {string} defaultPropName - name of the default prop\n * @returns {function} A function that return Error if designated prop is\n * supplied without a corresponding handler function\n */","meta":{"filename":"fzitauf2iwl3as4skbekgy.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Ensure that a corresponding handler function is provided for the given prop if the\ncomponent does not manage its own state.\n\n```js-code\n import { controllable } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n selected: controllable(PropTypes.bool, 'onSelect', 'defaultSelected'),\n onSelect: PropTypes.func,\n defaultSelected: PropTypes.bool\n }\n ...\n```\n\nThis will throw an error if the 'selected' prop is supplied without a corresponding\n'onSelect' handler and will recommend using 'defaultSelected' instead.","kind":"module","name":"controllable","params":[{"type":{"names":["function"]},"description":"validates the prop type. Returns null if valid, error otherwise","name":"checkType"},{"type":{"names":["string"]},"description":"name of the handler function","name":"handlerName"},{"type":{"names":["string"]},"description":"name of the default prop","name":"defaultPropName"}],"returns":[{"type":{"names":["function"]},"description":"A function that return Error if designated prop is\nsupplied without a corresponding handler function"}],"longname":"module:controllable","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/controllable.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/controllable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/controllable.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/controllable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/controllable.ts').default","esPath":"@instructure/ui-prop-types/es/controllable","themePath":"packages/ui-prop-types/src/controllable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/controllable.ts","id":"controllable","title":"controllable"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Ensure that a corresponding handler function is provided for the given prop if the\n * component does not manage its own state.\n *\n * ```js-code\n * import { controllable } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * selected: controllable(PropTypes.bool, 'onSelect', 'defaultSelected'),\n * onSelect: PropTypes.func,\n * defaultSelected: PropTypes.bool\n * }\n * ...\n * ```\n *\n * This will throw an error if the 'selected' prop is supplied without a corresponding\n * 'onSelect' handler and will recommend using 'defaultSelected' instead.\n * @module controllable\n * @param {function} checkType - validates the prop type. Returns null if valid, error otherwise\n * @param {string} handlerName - name of the handler function\n * @param {string} defaultPropName - name of the default prop\n * @returns {function} A function that return Error if designated prop is\n * supplied without a corresponding handler function\n */","meta":{"filename":"et61agli4ck5u2l727zl9t.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Ensure that a corresponding handler function is provided for the given prop if the\ncomponent does not manage its own state.\n\n```js-code\n import { controllable } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n selected: controllable(PropTypes.bool, 'onSelect', 'defaultSelected'),\n onSelect: PropTypes.func,\n defaultSelected: PropTypes.bool\n }\n ...\n```\n\nThis will throw an error if the 'selected' prop is supplied without a corresponding\n'onSelect' handler and will recommend using 'defaultSelected' instead.","kind":"module","name":"controllable","params":[{"type":{"names":["function"]},"description":"validates the prop type. Returns null if valid, error otherwise","name":"checkType"},{"type":{"names":["string"]},"description":"name of the handler function","name":"handlerName"},{"type":{"names":["string"]},"description":"name of the default prop","name":"defaultPropName"}],"returns":[{"type":{"names":["function"]},"description":"A function that return Error if designated prop is\nsupplied without a corresponding handler function"}],"longname":"module:controllable","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/controllable.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/controllable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/controllable.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/controllable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/controllable.ts').default","esPath":"@instructure/ui-prop-types/es/controllable","themePath":"packages/ui-prop-types/src/controllable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/controllable.ts","id":"controllable","title":"controllable"} \ No newline at end of file diff --git a/docs/conversions.json b/docs/conversions.json index 4d6f2c88c4..4c6bf53431 100644 --- a/docs/conversions.json +++ b/docs/conversions.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Color conversion utilities to transform between `TinyColor` colors (https://github.com/bgrins/TinyColor)\n * @module conversions\n */","meta":{"filename":"lu9fhy1l43w5z6rn20re.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Color conversion utilities to transform between `TinyColor` colors (https://github.com/bgrins/TinyColor)","kind":"module","name":"conversions","longname":"module:conversions","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/conversions.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/conversions.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/conversions.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/conversions","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/conversions.ts').default","esPath":"@instructure/ui-color-utils/es/conversions","themePath":"packages/ui-color-utils/src/conversions.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/conversions.ts","id":"conversions","title":"conversions"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Color conversion utilities to transform between `TinyColor` colors (https://github.com/bgrins/TinyColor)\n * @module conversions\n */","meta":{"filename":"mll1ddb64shbwda2remur.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Color conversion utilities to transform between `TinyColor` colors (https://github.com/bgrins/TinyColor)","kind":"module","name":"conversions","longname":"module:conversions","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/conversions.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/conversions.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/conversions.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/conversions","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/conversions.ts').default","esPath":"@instructure/ui-color-utils/es/conversions","themePath":"packages/ui-color-utils/src/conversions.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/conversions.ts","id":"conversions","title":"conversions"} \ No newline at end of file diff --git a/docs/createChainedFunction.json b/docs/createChainedFunction.json index e5a7982da0..66c805a951 100644 --- a/docs/createChainedFunction.json +++ b/docs/createChainedFunction.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Safe chained functions\n *\n * Will only create a new function if needed,\n * otherwise will pass back existing functions or null.\n *\n * Forked from: https://github.com/react-bootstrap/react-overlays/blob/master/src/utils/createChainedFunction.js\n * @module createChainedFunction\n * @param {function} funcs to chain\n * @returns {function|null}\n */","meta":{"filename":"i5mf25bded6wckghpx7vv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Safe chained functions\n\nWill only create a new function if needed,\notherwise will pass back existing functions or null.\n\nForked from: https://github.com/react-bootstrap/react-overlays/blob/master/src/utils/createChainedFunction.js","kind":"module","name":"createChainedFunction","params":[{"type":{"names":["function"]},"description":"to chain","name":"funcs"}],"returns":[{"type":{"names":["function","null"]}}],"longname":"module:createChainedFunction","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-utils/src/createChainedFunction.ts","extension":".ts","srcPath":"packages/ui-utils/src/createChainedFunction.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/createChainedFunction.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/createChainedFunction","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/createChainedFunction.ts').default","esPath":"@instructure/ui-utils/es/createChainedFunction","themePath":"packages/ui-utils/src/createChainedFunction.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/createChainedFunction.ts","id":"createChainedFunction","title":"createChainedFunction"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Safe chained functions\n *\n * Will only create a new function if needed,\n * otherwise will pass back existing functions or null.\n *\n * Forked from: https://github.com/react-bootstrap/react-overlays/blob/master/src/utils/createChainedFunction.js\n * @module createChainedFunction\n * @param {function} funcs to chain\n * @returns {function|null}\n */","meta":{"filename":"9pzoagknh675rj8d1hpvuj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Safe chained functions\n\nWill only create a new function if needed,\notherwise will pass back existing functions or null.\n\nForked from: https://github.com/react-bootstrap/react-overlays/blob/master/src/utils/createChainedFunction.js","kind":"module","name":"createChainedFunction","params":[{"type":{"names":["function"]},"description":"to chain","name":"funcs"}],"returns":[{"type":{"names":["function","null"]}}],"longname":"module:createChainedFunction","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-utils/src/createChainedFunction.ts","extension":".ts","srcPath":"packages/ui-utils/src/createChainedFunction.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/createChainedFunction.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/createChainedFunction","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/createChainedFunction.ts').default","esPath":"@instructure/ui-utils/es/createChainedFunction","themePath":"packages/ui-utils/src/createChainedFunction.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/createChainedFunction.ts","id":"createChainedFunction","title":"createChainedFunction"} \ No newline at end of file diff --git a/docs/cursor.json b/docs/cursor.json index a4471e4e37..4463425dfb 100644 --- a/docs/cursor.json +++ b/docs/cursor.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that the given prop is a valid css `cursor` value.\n *\n * The list of possible cursor values is taken from\n * https://developer.mozilla.org/en-US/docs/Web/CSS/cursor.\n *\n * Note that this does not currently support `url(...)` values.\n * @module cursor\n */","meta":{"filename":"q5rm6hnkz0s5g8lygx15c3.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that the given prop is a valid css `cursor` value.\n\nThe list of possible cursor values is taken from\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor.\n\nNote that this does not currently support `url(...)` values.","kind":"module","name":"cursor","longname":"module:cursor","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/cursor.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/cursor.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/cursor.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/cursor","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/cursor.ts').default","esPath":"@instructure/ui-prop-types/es/cursor","themePath":"packages/ui-prop-types/src/cursor.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/cursor.ts","id":"cursor","title":"cursor"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that the given prop is a valid css `cursor` value.\n *\n * The list of possible cursor values is taken from\n * https://developer.mozilla.org/en-US/docs/Web/CSS/cursor.\n *\n * Note that this does not currently support `url(...)` values.\n * @module cursor\n */","meta":{"filename":"wze0dgfjkdr1wbjmlgmjwj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that the given prop is a valid css `cursor` value.\n\nThe list of possible cursor values is taken from\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor.\n\nNote that this does not currently support `url(...)` values.","kind":"module","name":"cursor","longname":"module:cursor","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/cursor.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/cursor.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/cursor.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/cursor","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/cursor.ts').default","esPath":"@instructure/ui-prop-types/es/cursor","themePath":"packages/ui-prop-types/src/cursor.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/cursor.ts","id":"cursor","title":"cursor"} \ No newline at end of file diff --git a/docs/darken.json b/docs/darken.json index 0023970b39..8da19585b5 100644 --- a/docs/darken.json +++ b/docs/darken.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * darken a color\n * @module darken\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"wulj5kk7llp9vj1udijf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"darken a color","kind":"module","name":"darken","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:darken","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/darken.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/darken.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/darken.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/darken","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/darken.ts').default","esPath":"@instructure/ui-color-utils/es/darken","themePath":"packages/ui-color-utils/src/darken.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/darken.ts","id":"darken","title":"darken"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * darken a color\n * @module darken\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"t7aurhuebhgrksh9jtnn3.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"darken a color","kind":"module","name":"darken","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:darken","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/darken.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/darken.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/darken.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/darken","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/darken.ts').default","esPath":"@instructure/ui-color-utils/es/darken","themePath":"packages/ui-color-utils/src/darken.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/darken.ts","id":"darken","title":"darken"} \ No newline at end of file diff --git a/docs/debounce.json b/docs/debounce.json index 56db367b84..f31cfeaac4 100644 --- a/docs/debounce.json +++ b/docs/debounce.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\n * since the last time the debounced function was invoked. The debounced function comes with a cancel\n * method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\n * to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\n * The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\n * debounced function return the result of the last func invocation.\n *\n * [lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\n * doesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\n * so this is forked from the lodash source.\n *\n * Note: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\n * on unmounted components.\n * @module debounce\n *\n * @param {Function} func The function to debounce.\n * @param {number} [wait=0] The number of milliseconds to delay.\n * @param {Object} [options={}] The options object.\n * @param {boolean} [options.leading=false]\n * Specify invoking on the leading edge of the timeout.\n * @param {number} [options.maxWait]\n * The maximum time `func` is allowed to be delayed before it's invoked.\n * @param {boolean} [options.trailing=true]\n * Specify invoking on the trailing edge of the timeout.\n * @returns {Function} Returns the new debounced function.\n */","meta":{"filename":"uk1mihmxera1aucde5zkjz.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\nsince the last time the debounced function was invoked. The debounced function comes with a cancel\nmethod to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\nto indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\nThe func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\ndebounced function return the result of the last func invocation.\n\n[lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\ndoesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\nso this is forked from the lodash source.\n\nNote: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\non unmounted components.","kind":"module","name":"debounce","params":[{"type":{"names":["function"]},"description":"The function to debounce.","name":"func"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay.","name":"wait"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":"{}","description":"The options object.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Specify invoking on the leading edge of the timeout.","name":"options.leading"},{"type":{"names":["number"]},"optional":true,"description":"The maximum time `func` is allowed to be delayed before it's invoked.","name":"options.maxWait"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Specify invoking on the trailing edge of the timeout.","name":"options.trailing"}],"returns":[{"type":{"names":["function"]},"description":"Returns the new debounced function."}],"longname":"module:debounce","undocumented":false,"category":"utilities","relativePath":"packages/debounce/src/debounce.ts","extension":".ts","srcPath":"packages/debounce/src/debounce.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","packageName":"@instructure/debounce","requirePath":"@instructure/debounce/lib/debounce","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/debounce/src/debounce.ts').default","esPath":"@instructure/debounce/es/debounce","themePath":"packages/debounce/src/debounce.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","id":"debounce","title":"debounce"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\n * since the last time the debounced function was invoked. The debounced function comes with a cancel\n * method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\n * to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\n * The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\n * debounced function return the result of the last func invocation.\n *\n * [lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\n * doesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\n * so this is forked from the lodash source.\n *\n * Note: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\n * on unmounted components.\n * @module debounce\n *\n * @param {Function} func The function to debounce.\n * @param {number} [wait=0] The number of milliseconds to delay.\n * @param {Object} [options={}] The options object.\n * @param {boolean} [options.leading=false]\n * Specify invoking on the leading edge of the timeout.\n * @param {number} [options.maxWait]\n * The maximum time `func` is allowed to be delayed before it's invoked.\n * @param {boolean} [options.trailing=true]\n * Specify invoking on the trailing edge of the timeout.\n * @returns {Function} Returns the new debounced function.\n */","meta":{"filename":"uosg399ytmoclmjiopiw1v.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\nsince the last time the debounced function was invoked. The debounced function comes with a cancel\nmethod to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\nto indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\nThe func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\ndebounced function return the result of the last func invocation.\n\n[lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\ndoesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\nso this is forked from the lodash source.\n\nNote: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\non unmounted components.","kind":"module","name":"debounce","params":[{"type":{"names":["function"]},"description":"The function to debounce.","name":"func"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay.","name":"wait"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":"{}","description":"The options object.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Specify invoking on the leading edge of the timeout.","name":"options.leading"},{"type":{"names":["number"]},"optional":true,"description":"The maximum time `func` is allowed to be delayed before it's invoked.","name":"options.maxWait"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Specify invoking on the trailing edge of the timeout.","name":"options.trailing"}],"returns":[{"type":{"names":["function"]},"description":"Returns the new debounced function."}],"longname":"module:debounce","undocumented":false,"category":"utilities","relativePath":"packages/debounce/src/debounce.ts","extension":".ts","srcPath":"packages/debounce/src/debounce.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","packageName":"@instructure/debounce","requirePath":"@instructure/debounce/lib/debounce","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/debounce/src/debounce.ts').default","esPath":"@instructure/debounce/es/debounce","themePath":"packages/debounce/src/debounce.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","id":"debounce","title":"debounce"} \ No newline at end of file diff --git a/docs/decorator.json b/docs/decorator.json index 071221aca9..0b06e89864 100644 --- a/docs/decorator.json +++ b/docs/decorator.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Wraps (decorates) a React component to add additional functionality\n *\n * @module decorator\n * @param {Function} decorate a function that returns a decorated component\n * @returns {Class} A decorated component class\n */","meta":{"filename":"icgr3mua95jwkw7xta50f.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Wraps (decorates) a React component to add additional functionality","kind":"module","name":"decorator","params":[{"type":{"names":["function"]},"description":"a function that returns a decorated component","name":"decorate"}],"returns":[{"type":{"names":["Class"]},"description":"A decorated component class"}],"longname":"module:decorator","undocumented":false,"category":"utilities","relativePath":"packages/ui-decorator/src/decorator.ts","extension":".ts","srcPath":"packages/ui-decorator/src/decorator.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-decorator/src/decorator.ts","packageName":"@instructure/ui-decorator","requirePath":"@instructure/ui-decorator/lib/decorator","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-decorator/src/decorator.ts').default","esPath":"@instructure/ui-decorator/es/decorator","themePath":"packages/ui-decorator/src/decorator.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-decorator/src/decorator.ts","id":"decorator","title":"decorator"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Wraps (decorates) a React component to add additional functionality\n *\n * @module decorator\n * @param {Function} decorate a function that returns a decorated component\n * @returns {Class} A decorated component class\n */","meta":{"filename":"t70ku96l41e7xthrzky6cf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Wraps (decorates) a React component to add additional functionality","kind":"module","name":"decorator","params":[{"type":{"names":["function"]},"description":"a function that returns a decorated component","name":"decorate"}],"returns":[{"type":{"names":["Class"]},"description":"A decorated component class"}],"longname":"module:decorator","undocumented":false,"category":"utilities","relativePath":"packages/ui-decorator/src/decorator.ts","extension":".ts","srcPath":"packages/ui-decorator/src/decorator.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-decorator/src/decorator.ts","packageName":"@instructure/ui-decorator","requirePath":"@instructure/ui-decorator/lib/decorator","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-decorator/src/decorator.ts').default","esPath":"@instructure/ui-decorator/es/decorator","themePath":"packages/ui-decorator/src/decorator.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-decorator/src/decorator.ts","id":"decorator","title":"decorator"} \ No newline at end of file diff --git a/docs/deepEqual.json b/docs/deepEqual.json index f85bf15da7..d0fd6a1e01 100644 --- a/docs/deepEqual.json +++ b/docs/deepEqual.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * A wrapper for [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal)\n * @module deepEqual\n */","meta":{"filename":"fl4w7abbbp9px56l0rnwlf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A wrapper for [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal)","kind":"module","name":"deepEqual","longname":"module:deepEqual","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/deepEqual.ts","extension":".ts","srcPath":"packages/ui-utils/src/deepEqual.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/deepEqual.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/deepEqual","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/deepEqual.ts').default","esPath":"@instructure/ui-utils/es/deepEqual","themePath":"packages/ui-utils/src/deepEqual.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/deepEqual.ts","id":"deepEqual","title":"deepEqual"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * A wrapper for [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal)\n * @module deepEqual\n */","meta":{"filename":"7a7td3cdsyfefu4sr9b0k.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A wrapper for [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal)","kind":"module","name":"deepEqual","longname":"module:deepEqual","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/deepEqual.ts","extension":".ts","srcPath":"packages/ui-utils/src/deepEqual.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/deepEqual.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/deepEqual","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/deepEqual.ts').default","esPath":"@instructure/ui-utils/es/deepEqual","themePath":"packages/ui-utils/src/deepEqual.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/deepEqual.ts","id":"deepEqual","title":"deepEqual"} \ No newline at end of file diff --git a/docs/deprecated.json b/docs/deprecated.json index b6a4ea475e..047fc4fc57 100644 --- a/docs/deprecated.json +++ b/docs/deprecated.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Deprecate React component props. Warnings will display in the console when deprecated\n * props are used. Include the version number when the deprecated component will be removed.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default deprecated('7.0.0', {\n * deprecatedProp: 'currentProp',\n * nowNonExistentProp: true\n * })(Example)\n * ```\n *\n * @param {string} version\n * @param {object} oldProps (if this argument is null or undefined, the entire component is deprecated)\n * @param {string} message\n * @return {function} React component with deprecated props behavior\n * @module deprecated\n */","meta":{"filename":"63frpipq6lsarhii8qzxgd.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deprecate React component props. Warnings will display in the console when deprecated\nprops are used. Include the version number when the deprecated component will be removed.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default deprecated('7.0.0', {\n deprecatedProp: 'currentProp',\n nowNonExistentProp: true\n })(Example)\n```","params":[{"type":{"names":["string"]},"name":"version"},{"type":{"names":["object"]},"description":"(if this argument is null or undefined, the entire component is deprecated)","name":"oldProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component with deprecated props behavior"}],"kind":"module","name":"deprecated","longname":"module:deprecated","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/deprecated.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/deprecated.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/deprecated.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/deprecated","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/deprecated.ts').default","esPath":"@instructure/ui-react-utils/es/deprecated","themePath":"packages/ui-react-utils/src/deprecated.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/deprecated.ts","id":"deprecated","title":"deprecated"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Deprecate React component props. Warnings will display in the console when deprecated\n * props are used. Include the version number when the deprecated component will be removed.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default deprecated('7.0.0', {\n * deprecatedProp: 'currentProp',\n * nowNonExistentProp: true\n * })(Example)\n * ```\n *\n * @param {string} version\n * @param {object} oldProps (if this argument is null or undefined, the entire component is deprecated)\n * @param {string} message\n * @return {function} React component with deprecated props behavior\n * @module deprecated\n */","meta":{"filename":"wx28pmrlmvrdd09kmlvwt7.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deprecate React component props. Warnings will display in the console when deprecated\nprops are used. Include the version number when the deprecated component will be removed.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default deprecated('7.0.0', {\n deprecatedProp: 'currentProp',\n nowNonExistentProp: true\n })(Example)\n```","params":[{"type":{"names":["string"]},"name":"version"},{"type":{"names":["object"]},"description":"(if this argument is null or undefined, the entire component is deprecated)","name":"oldProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component with deprecated props behavior"}],"kind":"module","name":"deprecated","longname":"module:deprecated","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/deprecated.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/deprecated.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/deprecated.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/deprecated","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/deprecated.ts').default","esPath":"@instructure/ui-react-utils/es/deprecated","themePath":"packages/ui-react-utils/src/deprecated.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/deprecated.ts","id":"deprecated","title":"deprecated"} \ No newline at end of file diff --git a/docs/element.json b/docs/element.json index 4b204dcf9e..13ae3f19e4 100644 --- a/docs/element.json +++ b/docs/element.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that the given prop is a valid React element. If the DOM is accessible,\n * also verify if the prop is an instance of `Element`.\n * @module element\n */","meta":{"filename":"dr5crqs6r74shlp29vnyai.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that the given prop is a valid React element. If the DOM is accessible,\nalso verify if the prop is an instance of `Element`.","kind":"module","name":"element","longname":"module:element","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/element.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/element.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/element.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/element","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/element.ts').default","esPath":"@instructure/ui-prop-types/es/element","themePath":"packages/ui-prop-types/src/element.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/element.ts","id":"element","title":"element"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that the given prop is a valid React element. If the DOM is accessible,\n * also verify if the prop is an instance of `Element`.\n * @module element\n */","meta":{"filename":"j4kc6kev5iyl2n1ow438.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that the given prop is a valid React element. If the DOM is accessible,\nalso verify if the prop is an instance of `Element`.","kind":"module","name":"element","longname":"module:element","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/element.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/element.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/element.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/element","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/element.ts').default","esPath":"@instructure/ui-prop-types/es/element","themePath":"packages/ui-prop-types/src/element.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/element.ts","id":"element","title":"element"} \ No newline at end of file diff --git a/docs/ensureSingleChild.json b/docs/ensureSingleChild.json index b621c1e3ed..913f079371 100644 --- a/docs/ensureSingleChild.json +++ b/docs/ensureSingleChild.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n *\n * Ensure a single child. If it is a child of length 1, return a\n * cloned instance of the child. If it is a child of length > 1,\n * wrap in a span and return the child. Return null if child has\n * no length.\n * @module ensureSingleChild\n * @param {ReactNode} child\n * @param {Object} props - props for child\n * @returns {ReactElement|null} cloned instance for a single child, or children wrapped in a span\n */","meta":{"filename":"jn1lw424qalbnjd44m6s.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nEnsure a single child. If it is a child of length 1, return a\ncloned instance of the child. If it is a child of length > 1,\nwrap in a span and return the child. Return null if child has\nno length.","kind":"module","name":"ensureSingleChild","params":[{"type":{"names":["ReactNode"]},"name":"child"},{"type":{"names":["Object"]},"description":"props for child","name":"props"}],"returns":[{"type":{"names":["ReactElement","null"]},"description":"cloned instance for a single child, or children wrapped in a span"}],"longname":"module:ensureSingleChild","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/ensureSingleChild.tsx","extension":".tsx","srcPath":"packages/ui-react-utils/src/ensureSingleChild.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/ensureSingleChild.tsx","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/ensureSingleChild","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/ensureSingleChild.tsx').default","esPath":"@instructure/ui-react-utils/es/ensureSingleChild","themePath":"packages/ui-react-utils/src/ensureSingleChild.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/ensureSingleChild.tsx","id":"ensureSingleChild","title":"ensureSingleChild"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n *\n * Ensure a single child. If it is a child of length 1, return a\n * cloned instance of the child. If it is a child of length > 1,\n * wrap in a span and return the child. Return null if child has\n * no length.\n * @module ensureSingleChild\n * @param {ReactNode} child\n * @param {Object} props - props for child\n * @returns {ReactElement|null} cloned instance for a single child, or children wrapped in a span\n */","meta":{"filename":"o4pe8gwb9mqq5pcdkfbk1.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nEnsure a single child. If it is a child of length 1, return a\ncloned instance of the child. If it is a child of length > 1,\nwrap in a span and return the child. Return null if child has\nno length.","kind":"module","name":"ensureSingleChild","params":[{"type":{"names":["ReactNode"]},"name":"child"},{"type":{"names":["Object"]},"description":"props for child","name":"props"}],"returns":[{"type":{"names":["ReactElement","null"]},"description":"cloned instance for a single child, or children wrapped in a span"}],"longname":"module:ensureSingleChild","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/ensureSingleChild.tsx","extension":".tsx","srcPath":"packages/ui-react-utils/src/ensureSingleChild.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/ensureSingleChild.tsx","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/ensureSingleChild","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/ensureSingleChild.tsx').default","esPath":"@instructure/ui-react-utils/es/ensureSingleChild","themePath":"packages/ui-react-utils/src/ensureSingleChild.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/ensureSingleChild.tsx","id":"ensureSingleChild","title":"ensureSingleChild"} \ No newline at end of file diff --git a/docs/experimental.json b/docs/experimental.json index 66711b9296..bc419460cd 100644 --- a/docs/experimental.json +++ b/docs/experimental.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Flag React component and component props as experimental.\n * Warnings will display in the console when experimental components/props\n * props are used.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default experimental(['experimentalProp'])(Example)\n * ```\n *\n * @module experimental\n * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)\n * @param {string} message\n * @return {function} React component flagged as experimental\n */","meta":{"filename":"hf4ndg9x44ffpszyfxk26s.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Flag React component and component props as experimental.\nWarnings will display in the console when experimental components/props\nprops are used.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default experimental(['experimentalProp'])(Example)\n```","kind":"module","name":"experimental","params":[{"type":{"names":["array"]},"description":"(if this argument is null or undefined, the entire component is flagged)","name":"experimentalProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component flagged as experimental"}],"longname":"module:experimental","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/experimental.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/experimental.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/experimental.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/experimental","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/experimental.ts').default","esPath":"@instructure/ui-react-utils/es/experimental","themePath":"packages/ui-react-utils/src/experimental.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/experimental.ts","id":"experimental","title":"experimental"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Flag React component and component props as experimental.\n * Warnings will display in the console when experimental components/props\n * props are used.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default experimental(['experimentalProp'])(Example)\n * ```\n *\n * @module experimental\n * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)\n * @param {string} message\n * @return {function} React component flagged as experimental\n */","meta":{"filename":"tw8ipwnhlb8y5w9wabumf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Flag React component and component props as experimental.\nWarnings will display in the console when experimental components/props\nprops are used.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default experimental(['experimentalProp'])(Example)\n```","kind":"module","name":"experimental","params":[{"type":{"names":["array"]},"description":"(if this argument is null or undefined, the entire component is flagged)","name":"experimentalProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component flagged as experimental"}],"longname":"module:experimental","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/experimental.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/experimental.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/experimental.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/experimental","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/experimental.ts').default","esPath":"@instructure/ui-react-utils/es/experimental","themePath":"packages/ui-react-utils/src/experimental.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/experimental.ts","id":"experimental","title":"experimental"} \ No newline at end of file diff --git a/docs/findDOMNode.json b/docs/findDOMNode.json index 7bbcf0d108..cd059c9b65 100644 --- a/docs/findDOMNode.json +++ b/docs/findDOMNode.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Wrapper function for React.findDOMNode\n * @module findDOMNode\n *\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component, DOM node, or function returning a DOM node\n * @returns { Node | Window | null | undefined } The root node of this element\n */","meta":{"filename":"ujhdpefqvxmbgorqq32vv8.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nWrapper function for React.findDOMNode","kind":"module","name":"findDOMNode","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component, DOM node, or function returning a DOM node","name":"el"}],"returns":[{"type":{"names":["Node","Window","null","undefined"]},"description":"The root node of this element"}],"longname":"module:findDOMNode","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/findDOMNode.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/findDOMNode.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findDOMNode.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/findDOMNode","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/findDOMNode.ts').default","esPath":"@instructure/ui-dom-utils/es/findDOMNode","themePath":"packages/ui-dom-utils/src/findDOMNode.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findDOMNode.ts","id":"findDOMNode","title":"findDOMNode"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Wrapper function for React.findDOMNode\n * @module findDOMNode\n *\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component, DOM node, or function returning a DOM node\n * @returns { Node | Window | null | undefined } The root node of this element\n */","meta":{"filename":"e9tr3rzt6aa7hpkm296oz9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nWrapper function for React.findDOMNode","kind":"module","name":"findDOMNode","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component, DOM node, or function returning a DOM node","name":"el"}],"returns":[{"type":{"names":["Node","Window","null","undefined"]},"description":"The root node of this element"}],"longname":"module:findDOMNode","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/findDOMNode.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/findDOMNode.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findDOMNode.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/findDOMNode","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/findDOMNode.ts').default","esPath":"@instructure/ui-dom-utils/es/findDOMNode","themePath":"packages/ui-dom-utils/src/findDOMNode.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findDOMNode.ts","id":"findDOMNode","title":"findDOMNode"} \ No newline at end of file diff --git a/docs/findFocusable.json b/docs/findFocusable.json index 1ab0910e8d..ccd3dfd12e 100644 --- a/docs/findFocusable.json +++ b/docs/findFocusable.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Given an element, finds and returns all visible, focusable children.\n * Focusable elements include input, select, textarea, button, and object.\n * Anchor tags are also focusable if they include an href or\n * tabindex attribute (including tabindices less than zero).\n * @module findFocusable\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param { function } filter - a function to filter the matching nodes\n * @param { boolean } shouldSearchRootNode - should the root node be included in the search\n * @returns { Array } array of all tabbable children\n */","meta":{"filename":"sy965b56bh96wmtdc9e5zh.js","lineno":13,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven an element, finds and returns all visible, focusable children.\nFocusable elements include input, select, textarea, button, and object.\nAnchor tags are also focusable if they include an href or\ntabindex attribute (including tabindices less than zero).","kind":"module","name":"findFocusable","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["function"]},"description":"a function to filter the matching nodes","name":"filter"},{"type":{"names":["boolean"]},"description":"should the root node be included in the search","name":"shouldSearchRootNode"}],"returns":[{"type":{"names":["Array"]},"description":"array of all tabbable children"}],"longname":"module:findFocusable","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-dom-utils/src/findFocusable.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/findFocusable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findFocusable.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/findFocusable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/findFocusable.ts').default","esPath":"@instructure/ui-dom-utils/es/findFocusable","themePath":"packages/ui-dom-utils/src/findFocusable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findFocusable.ts","id":"findFocusable","title":"findFocusable"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Given an element, finds and returns all visible, focusable children.\n * Focusable elements include input, select, textarea, button, and object.\n * Anchor tags are also focusable if they include an href or\n * tabindex attribute (including tabindices less than zero).\n * @module findFocusable\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param { function } filter - a function to filter the matching nodes\n * @param { boolean } shouldSearchRootNode - should the root node be included in the search\n * @returns { Array } array of all tabbable children\n */","meta":{"filename":"mcp008502ouaq6fzxl2gj.js","lineno":13,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven an element, finds and returns all visible, focusable children.\nFocusable elements include input, select, textarea, button, and object.\nAnchor tags are also focusable if they include an href or\ntabindex attribute (including tabindices less than zero).","kind":"module","name":"findFocusable","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["function"]},"description":"a function to filter the matching nodes","name":"filter"},{"type":{"names":["boolean"]},"description":"should the root node be included in the search","name":"shouldSearchRootNode"}],"returns":[{"type":{"names":["Array"]},"description":"array of all tabbable children"}],"longname":"module:findFocusable","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-dom-utils/src/findFocusable.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/findFocusable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findFocusable.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/findFocusable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/findFocusable.ts').default","esPath":"@instructure/ui-dom-utils/es/findFocusable","themePath":"packages/ui-dom-utils/src/findFocusable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findFocusable.ts","id":"findFocusable","title":"findFocusable"} \ No newline at end of file diff --git a/docs/findTabbable.json b/docs/findTabbable.json index c60e4be66e..912db43da2 100644 --- a/docs/findTabbable.json +++ b/docs/findTabbable.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Given an element, finds and returns all visible, tabbable children.\n * Tabbable elements include input, select, textarea, button, and object.\n * Anchor tags are also tabbable if they include an href or zero or positive\n * tabindex attribute (to include elements with negative tabindex attributes,\n * use findFocusable).\n *\n * @module findTabbable\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param { boolean } shouldSearchRootNode - should the root node be included in the search\n * @returns { Array } array of all tabbable children\n */","meta":{"filename":"4htcwoe36yjzhrxbpw4guk.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven an element, finds and returns all visible, tabbable children.\nTabbable elements include input, select, textarea, button, and object.\nAnchor tags are also tabbable if they include an href or zero or positive\ntabindex attribute (to include elements with negative tabindex attributes,\nuse findFocusable).","kind":"module","name":"findTabbable","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"description":"should the root node be included in the search","name":"shouldSearchRootNode"}],"returns":[{"type":{"names":["Array"]},"description":"array of all tabbable children"}],"longname":"module:findTabbable","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-dom-utils/src/findTabbable.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/findTabbable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findTabbable.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/findTabbable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/findTabbable.ts').default","esPath":"@instructure/ui-dom-utils/es/findTabbable","themePath":"packages/ui-dom-utils/src/findTabbable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findTabbable.ts","id":"findTabbable","title":"findTabbable"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Given an element, finds and returns all visible, tabbable children.\n * Tabbable elements include input, select, textarea, button, and object.\n * Anchor tags are also tabbable if they include an href or zero or positive\n * tabindex attribute (to include elements with negative tabindex attributes,\n * use findFocusable).\n *\n * @module findTabbable\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param { boolean } shouldSearchRootNode - should the root node be included in the search\n * @returns { Array } array of all tabbable children\n */","meta":{"filename":"mhec35ub7rp7j3bczk33ha.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven an element, finds and returns all visible, tabbable children.\nTabbable elements include input, select, textarea, button, and object.\nAnchor tags are also tabbable if they include an href or zero or positive\ntabindex attribute (to include elements with negative tabindex attributes,\nuse findFocusable).","kind":"module","name":"findTabbable","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"description":"should the root node be included in the search","name":"shouldSearchRootNode"}],"returns":[{"type":{"names":["Array"]},"description":"array of all tabbable children"}],"longname":"module:findTabbable","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-dom-utils/src/findTabbable.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/findTabbable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findTabbable.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/findTabbable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/findTabbable.ts').default","esPath":"@instructure/ui-dom-utils/es/findTabbable","themePath":"packages/ui-dom-utils/src/findTabbable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/findTabbable.ts","id":"findTabbable","title":"findTabbable"} \ No newline at end of file diff --git a/docs/getActiveElement.json b/docs/getActiveElement.json index 24644e1685..6f4992acb8 100644 --- a/docs/getActiveElement.json +++ b/docs/getActiveElement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Get the active element of the specified document\n * @module getActiveElement\n * @param { Document } doc - document by default or user specified doc\n * @return { Element | null } the active element\n */","meta":{"filename":"ax44d22081d6qsh7urzu5y.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGet the active element of the specified document","kind":"module","name":"getActiveElement","params":[{"type":{"names":["Document"]},"description":"document by default or user specified doc","name":"doc"}],"returns":[{"type":{"names":["Element","null"]},"description":"the active element"}],"longname":"module:getActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/getActiveElement","themePath":"packages/ui-dom-utils/src/getActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getActiveElement.ts","id":"getActiveElement","title":"getActiveElement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Get the active element of the specified document\n * @module getActiveElement\n * @param { Document } doc - document by default or user specified doc\n * @return { Element | null } the active element\n */","meta":{"filename":"5wyy07cqj9v6y8t0y57xd.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGet the active element of the specified document","kind":"module","name":"getActiveElement","params":[{"type":{"names":["Document"]},"description":"document by default or user specified doc","name":"doc"}],"returns":[{"type":{"names":["Element","null"]},"description":"the active element"}],"longname":"module:getActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/getActiveElement","themePath":"packages/ui-dom-utils/src/getActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getActiveElement.ts","id":"getActiveElement","title":"getActiveElement"} \ No newline at end of file diff --git a/docs/getBoundingClientRect.json b/docs/getBoundingClientRect.json index 5adcc29a2f..e3db776d8b 100644 --- a/docs/getBoundingClientRect.json +++ b/docs/getBoundingClientRect.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Gets the bounding rectangle of an element\n * @module getBoundingClientRect\n *\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component, DOM node, or function returning a DOM node\n * @return {object} rect - object with top, left coords and height and width\n */","meta":{"filename":"jico89xkqfia7oxgab8rjq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGets the bounding rectangle of an element","kind":"module","name":"getBoundingClientRect","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component, DOM node, or function returning a DOM node","name":"el"}],"returns":[{"type":{"names":["object"]},"description":"rect - object with top, left coords and height and width"}],"longname":"module:getBoundingClientRect","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getBoundingClientRect.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getBoundingClientRect.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getBoundingClientRect.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getBoundingClientRect","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getBoundingClientRect.ts').default","esPath":"@instructure/ui-dom-utils/es/getBoundingClientRect","themePath":"packages/ui-dom-utils/src/getBoundingClientRect.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getBoundingClientRect.ts","id":"getBoundingClientRect","title":"getBoundingClientRect"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Gets the bounding rectangle of an element\n * @module getBoundingClientRect\n *\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component, DOM node, or function returning a DOM node\n * @return {object} rect - object with top, left coords and height and width\n */","meta":{"filename":"pg9i9l7d83j9hnwlixdqm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGets the bounding rectangle of an element","kind":"module","name":"getBoundingClientRect","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component, DOM node, or function returning a DOM node","name":"el"}],"returns":[{"type":{"names":["object"]},"description":"rect - object with top, left coords and height and width"}],"longname":"module:getBoundingClientRect","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getBoundingClientRect.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getBoundingClientRect.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getBoundingClientRect.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getBoundingClientRect","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getBoundingClientRect.ts').default","esPath":"@instructure/ui-dom-utils/es/getBoundingClientRect","themePath":"packages/ui-dom-utils/src/getBoundingClientRect.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getBoundingClientRect.ts","id":"getBoundingClientRect","title":"getBoundingClientRect"} \ No newline at end of file diff --git a/docs/getBrowser.json b/docs/getBrowser.json index c76c022e73..b2189b35a5 100644 --- a/docs/getBrowser.json +++ b/docs/getBrowser.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * A utility module using the [ua-parser-js](https://www.npmjs.com/package/ua-parser-js) browser\n * detection library.\n *\n * @module getBrowser\n */","meta":{"filename":"ycina8lrmmk7otl686039q.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A utility module using the [ua-parser-js](https://www.npmjs.com/package/ua-parser-js) browser\ndetection library.","kind":"module","name":"getBrowser","longname":"module:getBrowser","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/getBrowser.ts","extension":".ts","srcPath":"packages/ui-utils/src/getBrowser.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/getBrowser.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/getBrowser","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/getBrowser.ts').default","esPath":"@instructure/ui-utils/es/getBrowser","themePath":"packages/ui-utils/src/getBrowser.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/getBrowser.ts","id":"getBrowser","title":"getBrowser"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * A utility module using the [ua-parser-js](https://www.npmjs.com/package/ua-parser-js) browser\n * detection library.\n *\n * @module getBrowser\n */","meta":{"filename":"otyxyeuuyvjnm3kby68vl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A utility module using the [ua-parser-js](https://www.npmjs.com/package/ua-parser-js) browser\ndetection library.","kind":"module","name":"getBrowser","longname":"module:getBrowser","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/getBrowser.ts","extension":".ts","srcPath":"packages/ui-utils/src/getBrowser.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/getBrowser.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/getBrowser","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/getBrowser.ts').default","esPath":"@instructure/ui-utils/es/getBrowser","themePath":"packages/ui-utils/src/getBrowser.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/getBrowser.ts","id":"getBrowser","title":"getBrowser"} \ No newline at end of file diff --git a/docs/getClassList.json b/docs/getClassList.json index 4d28d7cbbe..5e69c7ff9c 100644 --- a/docs/getClassList.json +++ b/docs/getClassList.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Produces a classList object containing functions\n * for both adding and removing classes from an element.\n * Also provides a contains function to query if the\n * element contains a specified class name.\n * @module getClassList\n *\n * @param { Node | Window | React.ReactElement | React.Component | function } element - component or DOM node\n * @return {Object} object containing classList functions 'contains', 'add', and 'remove'\n */","meta":{"filename":"ymrshduihzp9w3giczxoiv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nProduces a classList object containing functions\nfor both adding and removing classes from an element.\nAlso provides a contains function to query if the\nelement contains a specified class name.","kind":"module","name":"getClassList","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"element"}],"returns":[{"type":{"names":["Object"]},"description":"object containing classList functions 'contains', 'add', and 'remove'"}],"longname":"module:getClassList","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getClassList.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getClassList.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getClassList.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getClassList","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getClassList.ts').default","esPath":"@instructure/ui-dom-utils/es/getClassList","themePath":"packages/ui-dom-utils/src/getClassList.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getClassList.ts","id":"getClassList","title":"getClassList"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Produces a classList object containing functions\n * for both adding and removing classes from an element.\n * Also provides a contains function to query if the\n * element contains a specified class name.\n * @module getClassList\n *\n * @param { Node | Window | React.ReactElement | React.Component | function } element - component or DOM node\n * @return {Object} object containing classList functions 'contains', 'add', and 'remove'\n */","meta":{"filename":"nqjk0y5q07r0wtm09senjj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nProduces a classList object containing functions\nfor both adding and removing classes from an element.\nAlso provides a contains function to query if the\nelement contains a specified class name.","kind":"module","name":"getClassList","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"element"}],"returns":[{"type":{"names":["Object"]},"description":"object containing classList functions 'contains', 'add', and 'remove'"}],"longname":"module:getClassList","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getClassList.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getClassList.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getClassList.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getClassList","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getClassList.ts').default","esPath":"@instructure/ui-dom-utils/es/getClassList","themePath":"packages/ui-dom-utils/src/getClassList.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getClassList.ts","id":"getClassList","title":"getClassList"} \ No newline at end of file diff --git a/docs/getComputedStyle.json b/docs/getComputedStyle.json index 1fc0b1799d..59e5bcc1fb 100644 --- a/docs/getComputedStyle.json +++ b/docs/getComputedStyle.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Get the associated CSS properties and values for a\n * specified element\n * @module getComputedStyle\n *\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @param { string | null | undefined } pseudoElt - A string specifying the pseudo-element to match. Omitted (or null ) for real elements.\n * @returns { Object } object containing css properties and values for the element\n */","meta":{"filename":"4qmd45wweig7en75bwy0l.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGet the associated CSS properties and values for a\nspecified element","kind":"module","name":"getComputedStyle","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"},{"type":{"names":["string","null","undefined"]},"description":"A string specifying the pseudo-element to match. Omitted (or null ) for real elements.","name":"pseudoElt"}],"returns":[{"type":{"names":["Object"]},"description":"object containing css properties and values for the element"}],"longname":"module:getComputedStyle","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getComputedStyle.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getComputedStyle.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getComputedStyle.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getComputedStyle","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getComputedStyle.ts').default","esPath":"@instructure/ui-dom-utils/es/getComputedStyle","themePath":"packages/ui-dom-utils/src/getComputedStyle.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getComputedStyle.ts","id":"getComputedStyle","title":"getComputedStyle"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Get the associated CSS properties and values for a\n * specified element\n * @module getComputedStyle\n *\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @param { string | null | undefined } pseudoElt - A string specifying the pseudo-element to match. Omitted (or null ) for real elements.\n * @returns { Object } object containing css properties and values for the element\n */","meta":{"filename":"lf3js2d9i9mtlxezud7jj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGet the associated CSS properties and values for a\nspecified element","kind":"module","name":"getComputedStyle","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"},{"type":{"names":["string","null","undefined"]},"description":"A string specifying the pseudo-element to match. Omitted (or null ) for real elements.","name":"pseudoElt"}],"returns":[{"type":{"names":["Object"]},"description":"object containing css properties and values for the element"}],"longname":"module:getComputedStyle","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getComputedStyle.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getComputedStyle.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getComputedStyle.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getComputedStyle","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getComputedStyle.ts').default","esPath":"@instructure/ui-dom-utils/es/getComputedStyle","themePath":"packages/ui-dom-utils/src/getComputedStyle.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getComputedStyle.ts","id":"getComputedStyle","title":"getComputedStyle"} \ No newline at end of file diff --git a/docs/getDisplayName.json b/docs/getDisplayName.json index e4b0fa1ddb..0eab9fc9b7 100644 --- a/docs/getDisplayName.json +++ b/docs/getDisplayName.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the displayName of a React component.\n * needs a babel plugin to work https://github.com/facebook/react/issues/4915 !!\n * @module getDisplayName\n * @param {ComponentType|String} ReactComponent\n * @returns {String} the component displayName\n */","meta":{"filename":"bf1lotgnajarxccbyl807.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Get the displayName of a React component.\nneeds a babel plugin to work https://github.com/facebook/react/issues/4915 !!","kind":"module","name":"getDisplayName","params":[{"type":{"names":["ComponentType","String"]},"name":"ReactComponent"}],"returns":[{"type":{"names":["String"]},"description":"the component displayName"}],"longname":"module:getDisplayName","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getDisplayName.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getDisplayName.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getDisplayName.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getDisplayName","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getDisplayName.ts').default","esPath":"@instructure/ui-react-utils/es/getDisplayName","themePath":"packages/ui-react-utils/src/getDisplayName.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getDisplayName.ts","id":"getDisplayName","title":"getDisplayName"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the displayName of a React component.\n * needs a babel plugin to work https://github.com/facebook/react/issues/4915 !!\n * @module getDisplayName\n * @param {ComponentType|String} ReactComponent\n * @returns {String} the component displayName\n */","meta":{"filename":"k7glvt3ggrcwdxlzza584.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Get the displayName of a React component.\nneeds a babel plugin to work https://github.com/facebook/react/issues/4915 !!","kind":"module","name":"getDisplayName","params":[{"type":{"names":["ComponentType","String"]},"name":"ReactComponent"}],"returns":[{"type":{"names":["String"]},"description":"the component displayName"}],"longname":"module:getDisplayName","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getDisplayName.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getDisplayName.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getDisplayName.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getDisplayName","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getDisplayName.ts').default","esPath":"@instructure/ui-react-utils/es/getDisplayName","themePath":"packages/ui-react-utils/src/getDisplayName.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getDisplayName.ts","id":"getDisplayName","title":"getDisplayName"} \ No newline at end of file diff --git a/docs/getElementType.json b/docs/getElementType.json index 9b5eefbb73..57c504e500 100644 --- a/docs/getElementType.json +++ b/docs/getElementType.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the React element type for a component.\n *\n * @module getElementType\n * @param {ComponentType} Component\n * @param {Object} props\n * @param {Function} getDefault an optional function that returns the default element type\n * @returns {String} the element type\n */","meta":{"filename":"vcq4cideir4ou28hhaj4p.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"Get the React element type for a component.","kind":"module","name":"getElementType","params":[{"type":{"names":["ComponentType"]},"name":"Component"},{"type":{"names":["Object"]},"name":"props"},{"type":{"names":["function"]},"description":"an optional function that returns the default element type","name":"getDefault"}],"returns":[{"type":{"names":["String"]},"description":"the element type"}],"longname":"module:getElementType","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getElementType.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getElementType.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getElementType","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getElementType.ts').default","esPath":"@instructure/ui-react-utils/es/getElementType","themePath":"packages/ui-react-utils/src/getElementType.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","id":"getElementType","title":"getElementType"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the React element type for a component.\n *\n * @module getElementType\n * @param {ComponentType} Component\n * @param {Object} props\n * @param {Function} getDefault an optional function that returns the default element type\n * @returns {String} the element type\n */","meta":{"filename":"z61pj6wlz6p9vuqpi5pig.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"Get the React element type for a component.","kind":"module","name":"getElementType","params":[{"type":{"names":["ComponentType"]},"name":"Component"},{"type":{"names":["Object"]},"name":"props"},{"type":{"names":["function"]},"description":"an optional function that returns the default element type","name":"getDefault"}],"returns":[{"type":{"names":["String"]},"description":"the element type"}],"longname":"module:getElementType","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getElementType.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getElementType.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getElementType","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getElementType.ts').default","esPath":"@instructure/ui-react-utils/es/getElementType","themePath":"packages/ui-react-utils/src/getElementType.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","id":"getElementType","title":"getElementType"} \ No newline at end of file diff --git a/docs/getFontSize.json b/docs/getFontSize.json index d1b1d7c46c..a4ed7ed156 100644 --- a/docs/getFontSize.json +++ b/docs/getFontSize.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Gets font size in px\n *\n * @module getFontSize\n * @param { Node | Window | React.ReactElement | React.Component | function | undefined | null } el - component or DOM node\n * @param { boolean } ignoreCache\n * @returns { number } font size in px\n */","meta":{"filename":"1dsdujrk6pxh7h2pc1qm55.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGets font size in px","kind":"module","name":"getFontSize","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","undefined","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"name":"ignoreCache"}],"returns":[{"type":{"names":["number"]},"description":"font size in px"}],"longname":"module:getFontSize","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getFontSize.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getFontSize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getFontSize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getFontSize.ts').default","esPath":"@instructure/ui-dom-utils/es/getFontSize","themePath":"packages/ui-dom-utils/src/getFontSize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","id":"getFontSize","title":"getFontSize"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Gets font size in px\n *\n * @module getFontSize\n * @param { Node | Window | React.ReactElement | React.Component | function | undefined | null } el - component or DOM node\n * @param { boolean } ignoreCache\n * @returns { number } font size in px\n */","meta":{"filename":"ylyct0umgj7wt9lqb7tqj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGets font size in px","kind":"module","name":"getFontSize","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","undefined","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"name":"ignoreCache"}],"returns":[{"type":{"names":["number"]},"description":"font size in px"}],"longname":"module:getFontSize","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getFontSize.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getFontSize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getFontSize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getFontSize.ts').default","esPath":"@instructure/ui-dom-utils/es/getFontSize","themePath":"packages/ui-dom-utils/src/getFontSize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","id":"getFontSize","title":"getFontSize"} \ No newline at end of file diff --git a/docs/getInteraction.json b/docs/getInteraction.json index 3ad6e425f1..11bceec6c2 100644 --- a/docs/getInteraction.json +++ b/docs/getInteraction.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\n * This is useful for form elements where consumers are able to either use the interaction prop as specified or the\n * native html disabled or readonly attributes\n * @module getInteraction\n * @param {Object} args\n * @param {Object} args.props - the component props\n * @param {string} args.props.interaction - specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'\n * @param {boolean} args.props.disabled - specifies if the component is disabled. Will take precedence over readOnly\n * @param {boolean} args.props.readOnly - specifies if the component is readonly\n * @param {Array} args.interactionTypes - an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default\n * @returns {String} one of 'enabled', 'disabled', or 'readonly'\n */","meta":{"filename":"2b61yfqtjmc2m12h1xp4dy.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\nThis is useful for form elements where consumers are able to either use the interaction prop as specified or the\nnative html disabled or readonly attributes","kind":"module","name":"getInteraction","params":[{"type":{"names":["Object"]},"name":"args"},{"type":{"names":["Object"]},"description":"the component props","name":"args.props"},{"type":{"names":["string"]},"description":"specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'","name":"args.props.interaction"},{"type":{"names":["boolean"]},"description":"specifies if the component is disabled. Will take precedence over readOnly","name":"args.props.disabled"},{"type":{"names":["boolean"]},"description":"specifies if the component is readonly","name":"args.props.readOnly"},{"type":{"names":["Array"]},"description":"an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default","name":"args.interactionTypes"}],"returns":[{"type":{"names":["String"]},"description":"one of 'enabled', 'disabled', or 'readonly'"}],"longname":"module:getInteraction","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getInteraction.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getInteraction.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getInteraction","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getInteraction.ts').default","esPath":"@instructure/ui-react-utils/es/getInteraction","themePath":"packages/ui-react-utils/src/getInteraction.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","id":"getInteraction","title":"getInteraction"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\n * This is useful for form elements where consumers are able to either use the interaction prop as specified or the\n * native html disabled or readonly attributes\n * @module getInteraction\n * @param {Object} args\n * @param {Object} args.props - the component props\n * @param {string} args.props.interaction - specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'\n * @param {boolean} args.props.disabled - specifies if the component is disabled. Will take precedence over readOnly\n * @param {boolean} args.props.readOnly - specifies if the component is readonly\n * @param {Array} args.interactionTypes - an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default\n * @returns {String} one of 'enabled', 'disabled', or 'readonly'\n */","meta":{"filename":"gomtm2enj5cdosfuq4ub5g.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\nThis is useful for form elements where consumers are able to either use the interaction prop as specified or the\nnative html disabled or readonly attributes","kind":"module","name":"getInteraction","params":[{"type":{"names":["Object"]},"name":"args"},{"type":{"names":["Object"]},"description":"the component props","name":"args.props"},{"type":{"names":["string"]},"description":"specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'","name":"args.props.interaction"},{"type":{"names":["boolean"]},"description":"specifies if the component is disabled. Will take precedence over readOnly","name":"args.props.disabled"},{"type":{"names":["boolean"]},"description":"specifies if the component is readonly","name":"args.props.readOnly"},{"type":{"names":["Array"]},"description":"an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default","name":"args.interactionTypes"}],"returns":[{"type":{"names":["String"]},"description":"one of 'enabled', 'disabled', or 'readonly'"}],"longname":"module:getInteraction","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getInteraction.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getInteraction.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getInteraction","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getInteraction.ts').default","esPath":"@instructure/ui-react-utils/es/getInteraction","themePath":"packages/ui-react-utils/src/getInteraction.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","id":"getInteraction","title":"getInteraction"} \ No newline at end of file diff --git a/docs/getOffsetParents.json b/docs/getOffsetParents.json index d6934c8cc9..fc88fd7de1 100644 --- a/docs/getOffsetParents.json +++ b/docs/getOffsetParents.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieves the offset parents of a specified element.\n * Includes parents of nodeType 1 (Element nodes such\n * as

or

) that have either been transformed\n * or that do not have static position.\n * @module getOffsetParents\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {Array} offset parents\n */","meta":{"filename":"o3ou3gyq94c2wt9d1ciis6.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieves the offset parents of a specified element.\nIncludes parents of nodeType 1 (Element nodes such\nas

or

) that have either been transformed\nor that do not have static position.","kind":"module","name":"getOffsetParents","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Array"]},"description":"offset parents"}],"longname":"module:getOffsetParents","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getOffsetParents.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getOffsetParents.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getOffsetParents.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getOffsetParents","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getOffsetParents.ts').default","esPath":"@instructure/ui-dom-utils/es/getOffsetParents","themePath":"packages/ui-dom-utils/src/getOffsetParents.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getOffsetParents.ts","id":"getOffsetParents","title":"getOffsetParents"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieves the offset parents of a specified element.\n * Includes parents of nodeType 1 (Element nodes such\n * as

or

) that have either been transformed\n * or that do not have static position.\n * @module getOffsetParents\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {Array} offset parents\n */","meta":{"filename":"9b45yhdoi2fqxvx2cshhu.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieves the offset parents of a specified element.\nIncludes parents of nodeType 1 (Element nodes such\nas

or

) that have either been transformed\nor that do not have static position.","kind":"module","name":"getOffsetParents","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Array"]},"description":"offset parents"}],"longname":"module:getOffsetParents","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getOffsetParents.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getOffsetParents.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getOffsetParents.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getOffsetParents","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getOffsetParents.ts').default","esPath":"@instructure/ui-dom-utils/es/getOffsetParents","themePath":"packages/ui-dom-utils/src/getOffsetParents.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getOffsetParents.ts","id":"getOffsetParents","title":"getOffsetParents"} \ No newline at end of file diff --git a/docs/getScrollParents.json b/docs/getScrollParents.json index 157e02179d..13540b8ede 100644 --- a/docs/getScrollParents.json +++ b/docs/getScrollParents.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieves the scroll parents of a specified element.\n * Includes parents of nodeType 1 (Element nodes such\n * as

or

) that have overflow css properties\n * set to auto, scroll, or overlay\n * @module getScrollParents\n *\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {Array} scroll parents\n */","meta":{"filename":"1i15x7frl2ohs9ixpq2fbcr.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieves the scroll parents of a specified element.\nIncludes parents of nodeType 1 (Element nodes such\nas

or

) that have overflow css properties\nset to auto, scroll, or overlay","kind":"module","name":"getScrollParents","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Array"]},"description":"scroll parents"}],"longname":"module:getScrollParents","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getScrollParents.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getScrollParents.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getScrollParents.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getScrollParents","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getScrollParents.ts').default","esPath":"@instructure/ui-dom-utils/es/getScrollParents","themePath":"packages/ui-dom-utils/src/getScrollParents.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getScrollParents.ts","id":"getScrollParents","title":"getScrollParents"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieves the scroll parents of a specified element.\n * Includes parents of nodeType 1 (Element nodes such\n * as

or

) that have overflow css properties\n * set to auto, scroll, or overlay\n * @module getScrollParents\n *\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {Array} scroll parents\n */","meta":{"filename":"7gvqsehllrskfuw8vkqgo.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieves the scroll parents of a specified element.\nIncludes parents of nodeType 1 (Element nodes such\nas

or

) that have overflow css properties\nset to auto, scroll, or overlay","kind":"module","name":"getScrollParents","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Array"]},"description":"scroll parents"}],"longname":"module:getScrollParents","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getScrollParents.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getScrollParents.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getScrollParents.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getScrollParents","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getScrollParents.ts').default","esPath":"@instructure/ui-dom-utils/es/getScrollParents","themePath":"packages/ui-dom-utils/src/getScrollParents.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getScrollParents.ts","id":"getScrollParents","title":"getScrollParents"} \ No newline at end of file diff --git a/docs/getShorthandPropValue.json b/docs/getShorthandPropValue.json index 9233a81b84..51e3c6251d 100644 --- a/docs/getShorthandPropValue.json +++ b/docs/getShorthandPropValue.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a theme object, a string of space delimited prop values,\n * and a propName prefix, combines each prop value with the\n * propName prefix and replaces it with a corresponding value\n * from the theme object.\n * @module getShorthandPropValue\n *\n * @param {String} componentName - the name of the component (for error messages)\n * @param {Object} componentTheme - a theme object of keys and values\n * @param {String} propValue - a space delimited string of values\n * @param {String} propName - a prefix to combine with each propValue\n * @returns {String} a string with each value replaced with a value from the theme object\n */","meta":{"filename":"pjh20u64paq0gapkboo8tbq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a theme object, a string of space delimited prop values,\nand a propName prefix, combines each prop value with the\npropName prefix and replaces it with a corresponding value\nfrom the theme object.","kind":"module","name":"getShorthandPropValue","params":[{"type":{"names":["String"]},"description":"the name of the component (for error messages)","name":"componentName"},{"type":{"names":["Object"]},"description":"a theme object of keys and values","name":"componentTheme"},{"type":{"names":["String"]},"description":"a space delimited string of values","name":"propValue"},{"type":{"names":["String"]},"description":"a prefix to combine with each propValue","name":"propName"}],"returns":[{"type":{"names":["String"]},"description":"a string with each value replaced with a value from the theme object"}],"longname":"module:getShorthandPropValue","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/getShorthandPropValue","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/getShorthandPropValue.ts').default","esPath":"@instructure/emotion/es/styleUtils/getShorthandPropValue","themePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","id":"getShorthandPropValue","title":"getShorthandPropValue"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a theme object, a string of space delimited prop values,\n * and a propName prefix, combines each prop value with the\n * propName prefix and replaces it with a corresponding value\n * from the theme object.\n * @module getShorthandPropValue\n *\n * @param {String} componentName - the name of the component (for error messages)\n * @param {Object} componentTheme - a theme object of keys and values\n * @param {String} propValue - a space delimited string of values\n * @param {String} propName - a prefix to combine with each propValue\n * @returns {String} a string with each value replaced with a value from the theme object\n */","meta":{"filename":"qed8ubr79eafw7zzcyifw.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a theme object, a string of space delimited prop values,\nand a propName prefix, combines each prop value with the\npropName prefix and replaces it with a corresponding value\nfrom the theme object.","kind":"module","name":"getShorthandPropValue","params":[{"type":{"names":["String"]},"description":"the name of the component (for error messages)","name":"componentName"},{"type":{"names":["Object"]},"description":"a theme object of keys and values","name":"componentTheme"},{"type":{"names":["String"]},"description":"a space delimited string of values","name":"propValue"},{"type":{"names":["String"]},"description":"a prefix to combine with each propValue","name":"propName"}],"returns":[{"type":{"names":["String"]},"description":"a string with each value replaced with a value from the theme object"}],"longname":"module:getShorthandPropValue","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/getShorthandPropValue","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/getShorthandPropValue.ts').default","esPath":"@instructure/emotion/es/styleUtils/getShorthandPropValue","themePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","id":"getShorthandPropValue","title":"getShorthandPropValue"} \ No newline at end of file diff --git a/docs/getTextDirection.json b/docs/getTextDirection.json index 1c402cef6c..5608bd6086 100644 --- a/docs/getTextDirection.json +++ b/docs/getTextDirection.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\n * is given, it returns the document's 'dir' value.\n * @module getTextDirection\n * @param {Element} element will use the element by default\n * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)\n */","meta":{"filename":"vv1vripzfdeoi15ee5oyos.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"\nReturn the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\nis given, it returns the document's 'dir' value.","kind":"module","name":"getTextDirection","params":[{"type":{"names":["Element"]},"description":"will use the element by default","name":"element"}],"returns":[{"type":{"names":["String"]},"description":"'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)"}],"longname":"module:getTextDirection","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/getTextDirection.ts","extension":".ts","srcPath":"packages/ui-i18n/src/getTextDirection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/getTextDirection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/getTextDirection.ts').default","esPath":"@instructure/ui-i18n/es/getTextDirection","themePath":"packages/ui-i18n/src/getTextDirection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","id":"getTextDirection","title":"getTextDirection"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\n * is given, it returns the document's 'dir' value.\n * @module getTextDirection\n * @param {Element} element will use the element by default\n * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)\n */","meta":{"filename":"edbruyr3ot8c5nn76qi89.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"\nReturn the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\nis given, it returns the document's 'dir' value.","kind":"module","name":"getTextDirection","params":[{"type":{"names":["Element"]},"description":"will use the element by default","name":"element"}],"returns":[{"type":{"names":["String"]},"description":"'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)"}],"longname":"module:getTextDirection","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/getTextDirection.ts","extension":".ts","srcPath":"packages/ui-i18n/src/getTextDirection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/getTextDirection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/getTextDirection.ts').default","esPath":"@instructure/ui-i18n/es/getTextDirection","themePath":"packages/ui-i18n/src/getTextDirection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","id":"getTextDirection","title":"getTextDirection"} \ No newline at end of file diff --git a/docs/hack.json b/docs/hack.json index 3390a1bc64..04b203824f 100644 --- a/docs/hack.json +++ b/docs/hack.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Flag React component props as hack props.\n * Warnings will display in the console when hack props are used.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default hack(['hackProp'])(Example)\n * ```\n *\n * @module hack\n * @param {array} hackProps\n * @param {string} message\n * @return {function} React component flagged as having hack props\n */","meta":{"filename":"w73w2wvmfhi7ws2mqsth2s.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Flag React component props as hack props.\nWarnings will display in the console when hack props are used.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default hack(['hackProp'])(Example)\n```","kind":"module","name":"hack","params":[{"type":{"names":["array"]},"name":"hackProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component flagged as having hack props"}],"longname":"module:hack","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/hack.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/hack.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/hack","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/hack.ts').default","esPath":"@instructure/ui-react-utils/es/hack","themePath":"packages/ui-react-utils/src/hack.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","id":"hack","title":"hack"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Flag React component props as hack props.\n * Warnings will display in the console when hack props are used.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default hack(['hackProp'])(Example)\n * ```\n *\n * @module hack\n * @param {array} hackProps\n * @param {string} message\n * @return {function} React component flagged as having hack props\n */","meta":{"filename":"5oh7527ai0f35fqosw62rw.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Flag React component props as hack props.\nWarnings will display in the console when hack props are used.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default hack(['hackProp'])(Example)\n```","kind":"module","name":"hack","params":[{"type":{"names":["array"]},"name":"hackProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component flagged as having hack props"}],"longname":"module:hack","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/hack.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/hack.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/hack","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/hack.ts').default","esPath":"@instructure/ui-react-utils/es/hack","themePath":"packages/ui-react-utils/src/hack.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","id":"hack","title":"hack"} \ No newline at end of file diff --git a/docs/handleMouseOverOut.json b/docs/handleMouseOverOut.json index d59e34dbf5..635ce7a86a 100644 --- a/docs/handleMouseOverOut.json +++ b/docs/handleMouseOverOut.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Simple implementation of mouseEnter and mouseLeave.\n * React's built version is broken: https://github.com/facebook/react/issues/4251\n * for cases when the trigger is disabled and mouseOut/Over can cause flicker moving\n * from one child element to another.\n *\n * @module handleMouseOverOut\n * @param handler {function} Callback function for handling the event\n * @param event {Event} The DOM Event that was fired\n */","meta":{"filename":"nph6mvkurknd8r2j3jnfag.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nSimple implementation of mouseEnter and mouseLeave.\nReact's built version is broken: https://github.com/facebook/react/issues/4251\nfor cases when the trigger is disabled and mouseOut/Over can cause flicker moving\nfrom one child element to another.","kind":"module","name":"handleMouseOverOut","params":[{"type":{"names":["function"]},"description":"Callback function for handling the event","name":"handler"},{"type":{"names":["Event"]},"description":"The DOM Event that was fired","name":"event"}],"longname":"module:handleMouseOverOut","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/handleMouseOverOut","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/handleMouseOverOut.ts').default","esPath":"@instructure/ui-dom-utils/es/handleMouseOverOut","themePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","id":"handleMouseOverOut","title":"handleMouseOverOut"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Simple implementation of mouseEnter and mouseLeave.\n * React's built version is broken: https://github.com/facebook/react/issues/4251\n * for cases when the trigger is disabled and mouseOut/Over can cause flicker moving\n * from one child element to another.\n *\n * @module handleMouseOverOut\n * @param handler {function} Callback function for handling the event\n * @param event {Event} The DOM Event that was fired\n */","meta":{"filename":"xm3naqkh95fg9pkcykf33l.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nSimple implementation of mouseEnter and mouseLeave.\nReact's built version is broken: https://github.com/facebook/react/issues/4251\nfor cases when the trigger is disabled and mouseOut/Over can cause flicker moving\nfrom one child element to another.","kind":"module","name":"handleMouseOverOut","params":[{"type":{"names":["function"]},"description":"Callback function for handling the event","name":"handler"},{"type":{"names":["Event"]},"description":"The DOM Event that was fired","name":"event"}],"longname":"module:handleMouseOverOut","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/handleMouseOverOut","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/handleMouseOverOut.ts').default","esPath":"@instructure/ui-dom-utils/es/handleMouseOverOut","themePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","id":"handleMouseOverOut","title":"handleMouseOverOut"} \ No newline at end of file diff --git a/docs/hasVisibleChildren.json b/docs/hasVisibleChildren.json index 896e1a1f11..7a76326dee 100644 --- a/docs/hasVisibleChildren.json +++ b/docs/hasVisibleChildren.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n * Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).\n * @module hasVisibleChildren\n * @param {ReactChildren} children - A react component's children prop\n * @return {boolean} whether any of the children are visible\n */","meta":{"filename":"r4yss6ytnd7lxtogq1ckoq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).","kind":"module","name":"hasVisibleChildren","params":[{"type":{"names":["ReactChildren"]},"description":"A react component's children prop","name":"children"}],"returns":[{"type":{"names":["boolean"]},"description":"whether any of the children are visible"}],"longname":"module:hasVisibleChildren","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/hasVisibleChildren","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/hasVisibleChildren.ts').default","esPath":"@instructure/ui-a11y-utils/es/hasVisibleChildren","themePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","id":"hasVisibleChildren","title":"hasVisibleChildren"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n * Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).\n * @module hasVisibleChildren\n * @param {ReactChildren} children - A react component's children prop\n * @return {boolean} whether any of the children are visible\n */","meta":{"filename":"4ggh7xef9vbiauoqeth4pk.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).","kind":"module","name":"hasVisibleChildren","params":[{"type":{"names":["ReactChildren"]},"description":"A react component's children prop","name":"children"}],"returns":[{"type":{"names":["boolean"]},"description":"whether any of the children are visible"}],"longname":"module:hasVisibleChildren","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/hasVisibleChildren","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/hasVisibleChildren.ts').default","esPath":"@instructure/ui-a11y-utils/es/hasVisibleChildren","themePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","id":"hasVisibleChildren","title":"hasVisibleChildren"} \ No newline at end of file diff --git a/docs/isActiveElement.json b/docs/isActiveElement.json index d16dfaeac1..8bfacc2288 100644 --- a/docs/isActiveElement.json +++ b/docs/isActiveElement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is the active element\n * @module isActiveElement\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {boolean} if the element is the active element\n */","meta":{"filename":"y4bd9mec3lsn4gxupc94s.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is the active element","kind":"module","name":"isActiveElement","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is the active element"}],"longname":"module:isActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isActiveElement","themePath":"packages/ui-dom-utils/src/isActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","id":"isActiveElement","title":"isActiveElement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is the active element\n * @module isActiveElement\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {boolean} if the element is the active element\n */","meta":{"filename":"02kfh3ngs4a147gv3bmwnmm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is the active element","kind":"module","name":"isActiveElement","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is the active element"}],"longname":"module:isActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isActiveElement","themePath":"packages/ui-dom-utils/src/isActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","id":"isActiveElement","title":"isActiveElement"} \ No newline at end of file diff --git a/docs/isDefinedCustomElement.json b/docs/isDefinedCustomElement.json index 0a5cc4025b..1abf779621 100644 --- a/docs/isDefinedCustomElement.json +++ b/docs/isDefinedCustomElement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Check whether an element is a defined custom element. (if it was defined with `customElements.define`)\n * @module isDefinedCustomElement\n * @param { Element } el - the element to check\n * @return { Boolean } whether the element is a custom element or not\n */","meta":{"filename":"nniivr9rjxqjm7hznkut8d.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nCheck whether an element is a defined custom element. (if it was defined with `customElements.define`)","kind":"module","name":"isDefinedCustomElement","params":[{"type":{"names":["Element"]},"description":"the element to check","name":"el"}],"returns":[{"type":{"names":["Boolean"]},"description":"whether the element is a custom element or not"}],"longname":"module:isDefinedCustomElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isDefinedCustomElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isDefinedCustomElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isDefinedCustomElement","themePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","id":"isDefinedCustomElement","title":"isDefinedCustomElement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Check whether an element is a defined custom element. (if it was defined with `customElements.define`)\n * @module isDefinedCustomElement\n * @param { Element } el - the element to check\n * @return { Boolean } whether the element is a custom element or not\n */","meta":{"filename":"k8q4ba40r8pzju9grxkoae.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nCheck whether an element is a defined custom element. (if it was defined with `customElements.define`)","kind":"module","name":"isDefinedCustomElement","params":[{"type":{"names":["Element"]},"description":"the element to check","name":"el"}],"returns":[{"type":{"names":["Boolean"]},"description":"whether the element is a custom element or not"}],"longname":"module:isDefinedCustomElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isDefinedCustomElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isDefinedCustomElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isDefinedCustomElement","themePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","id":"isDefinedCustomElement","title":"isDefinedCustomElement"} \ No newline at end of file diff --git a/docs/isValid.json b/docs/isValid.json index 4c7cb8119d..6db8957f00 100644 --- a/docs/isValid.json +++ b/docs/isValid.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * check if a string is a valid color\n * @module isValid\n * @param {String} color\n * @returns {Boolean} true if the string is a valid color\n */","meta":{"filename":"0z83kwxchg5cprph9eqzral.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"check if a string is a valid color","kind":"module","name":"isValid","params":[{"type":{"names":["String"]},"name":"color"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the string is a valid color"}],"longname":"module:isValid","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/isValid.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/isValid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/isValid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/isValid.ts').default","esPath":"@instructure/ui-color-utils/es/isValid","themePath":"packages/ui-color-utils/src/isValid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","id":"isValid","title":"isValid"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * check if a string is a valid color\n * @module isValid\n * @param {String} color\n * @returns {Boolean} true if the string is a valid color\n */","meta":{"filename":"f8gyzwpl01nvwvj940tlfg.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"check if a string is a valid color","kind":"module","name":"isValid","params":[{"type":{"names":["String"]},"name":"color"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the string is a valid color"}],"longname":"module:isValid","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/isValid.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/isValid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/isValid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/isValid.ts').default","esPath":"@instructure/ui-color-utils/es/isValid","themePath":"packages/ui-color-utils/src/isValid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","id":"isValid","title":"isValid"} \ No newline at end of file diff --git a/docs/isVisible.json b/docs/isVisible.json index f4e88cdfda..c049292ba5 100644 --- a/docs/isVisible.json +++ b/docs/isVisible.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is visible.\n *\n * @module isVisible\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param {boolean} recursive - by default all parent elements are checked\n * recursively to accurately determine visibility. setting this to `false`\n * will determine visibility based only on the styles of the given node.\n * @returns {boolean} if the element is visible\n */","meta":{"filename":"r0kw84wr8moe2nkmmx5jf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is visible.","kind":"module","name":"isVisible","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"description":"by default all parent elements are checked\nrecursively to accurately determine visibility. setting this to `false`\nwill determine visibility based only on the styles of the given node.","name":"recursive"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is visible"}],"longname":"module:isVisible","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isVisible.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isVisible.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isVisible","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isVisible.ts').default","esPath":"@instructure/ui-dom-utils/es/isVisible","themePath":"packages/ui-dom-utils/src/isVisible.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","id":"isVisible","title":"isVisible"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is visible.\n *\n * @module isVisible\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param {boolean} recursive - by default all parent elements are checked\n * recursively to accurately determine visibility. setting this to `false`\n * will determine visibility based only on the styles of the given node.\n * @returns {boolean} if the element is visible\n */","meta":{"filename":"ybxpwqev2wkxor5hxifgf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is visible.","kind":"module","name":"isVisible","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"description":"by default all parent elements are checked\nrecursively to accurately determine visibility. setting this to `false`\nwill determine visibility based only on the styles of the given node.","name":"recursive"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is visible"}],"longname":"module:isVisible","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isVisible.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isVisible.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isVisible","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isVisible.ts').default","esPath":"@instructure/ui-dom-utils/es/isVisible","themePath":"packages/ui-dom-utils/src/isVisible.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","id":"isVisible","title":"isVisible"} \ No newline at end of file diff --git a/docs/jsonToMediaQuery.json b/docs/jsonToMediaQuery.json index 2d1c2cf478..516e4444c1 100644 --- a/docs/jsonToMediaQuery.json +++ b/docs/jsonToMediaQuery.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a valid json query object, converts it to a standard media query\n * string. Valid queries should be an object consisting of condition:breakpoint\n * pairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\n * or `maxHeight` where breakpoint value is either a string or a number.\n *\n * Example input\n * ```js-code\n * { minWidth: 350, maxWidth: 600 }\n * ```\n * Example output\n * ```js-code\n * '(min-width: 350px) and (max-Width: 600px)'\n * ```\n * @module jsonToMediaQuery\n * @param {Object} query - an object consisting of the query type and value\n * @param {Document | Window | Node | React.ReactElement | React.Component} el - component or DOM node which will be passed to the pixel conversion if the unit type is `em`\n * @returns {string} media query string\n */","meta":{"filename":"1ejlp81bfwtkbbv5fpejt8.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a valid json query object, converts it to a standard media query\nstring. Valid queries should be an object consisting of condition:breakpoint\npairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\nor `maxHeight` where breakpoint value is either a string or a number.\n\nExample input\n```js-code\n{ minWidth: 350, maxWidth: 600 }\n```\nExample output\n```js-code\n'(min-width: 350px) and (max-Width: 600px)'\n```","kind":"module","name":"jsonToMediaQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of the query type and value","name":"query"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component"]},"description":"component or DOM node which will be passed to the pixel conversion if the unit type is `em`","name":"el"}],"returns":[{"type":{"names":["string"]},"description":"media query string"}],"longname":"module:jsonToMediaQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/jsonToMediaQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/jsonToMediaQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/jsonToMediaQuery.ts').default","esPath":"@instructure/ui-responsive/es/jsonToMediaQuery","themePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","id":"jsonToMediaQuery","title":"jsonToMediaQuery"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a valid json query object, converts it to a standard media query\n * string. Valid queries should be an object consisting of condition:breakpoint\n * pairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\n * or `maxHeight` where breakpoint value is either a string or a number.\n *\n * Example input\n * ```js-code\n * { minWidth: 350, maxWidth: 600 }\n * ```\n * Example output\n * ```js-code\n * '(min-width: 350px) and (max-Width: 600px)'\n * ```\n * @module jsonToMediaQuery\n * @param {Object} query - an object consisting of the query type and value\n * @param {Document | Window | Node | React.ReactElement | React.Component} el - component or DOM node which will be passed to the pixel conversion if the unit type is `em`\n * @returns {string} media query string\n */","meta":{"filename":"8zyrak1250i2xyi8mtab1e.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a valid json query object, converts it to a standard media query\nstring. Valid queries should be an object consisting of condition:breakpoint\npairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\nor `maxHeight` where breakpoint value is either a string or a number.\n\nExample input\n```js-code\n{ minWidth: 350, maxWidth: 600 }\n```\nExample output\n```js-code\n'(min-width: 350px) and (max-Width: 600px)'\n```","kind":"module","name":"jsonToMediaQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of the query type and value","name":"query"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component"]},"description":"component or DOM node which will be passed to the pixel conversion if the unit type is `em`","name":"el"}],"returns":[{"type":{"names":["string"]},"description":"media query string"}],"longname":"module:jsonToMediaQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/jsonToMediaQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/jsonToMediaQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/jsonToMediaQuery.ts').default","esPath":"@instructure/ui-responsive/es/jsonToMediaQuery","themePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","id":"jsonToMediaQuery","title":"jsonToMediaQuery"} \ No newline at end of file diff --git a/docs/lighten.json b/docs/lighten.json index 8859a2af0c..ad4060dba8 100644 --- a/docs/lighten.json +++ b/docs/lighten.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * lighten a color\n * @module lighten\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"7e7m28tzittbope3m1tvq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"lighten a color","kind":"module","name":"lighten","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:lighten","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/lighten.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/lighten.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/lighten","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/lighten.ts').default","esPath":"@instructure/ui-color-utils/es/lighten","themePath":"packages/ui-color-utils/src/lighten.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","id":"lighten","title":"lighten"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * lighten a color\n * @module lighten\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"e2qkm5htjg63efywips3uc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"lighten a color","kind":"module","name":"lighten","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:lighten","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/lighten.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/lighten.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/lighten","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/lighten.ts').default","esPath":"@instructure/ui-color-utils/es/lighten","themePath":"packages/ui-color-utils/src/lighten.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","id":"lighten","title":"lighten"} \ No newline at end of file diff --git a/docs/makeRequirable.json b/docs/makeRequirable.json index a2aa6d0cf8..799d8fde3c 100644 --- a/docs/makeRequirable.json +++ b/docs/makeRequirable.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Given a validator function, extends the validator functionality to also\n * ensure that the prop has been provided if `.isRequired` is specified.\n *\n * ```js-code\n * function validator (props, propName, componentName) {\n * const propValue = props[propName]\n * if (propValue === 'purple') {\n * return new Error(`Purple is not accepted in ${componentName}!`)\n * }\n * }\n *\n * validator.isRequired = makeRequirable(validator)\n * ```\n * @module makeRequirable\n * @param {function} validator - a validator function\n * @returns {function} A function that returns Error if designated prop is not provided\n */","meta":{"filename":"gxbb0leevpj062tfbarow9e.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a validator function, extends the validator functionality to also\nensure that the prop has been provided if `.isRequired` is specified.\n\n```js-code\nfunction validator (props, propName, componentName) {\n const propValue = props[propName]\n if (propValue === 'purple') {\n return new Error(`Purple is not accepted in ${componentName}!`)\n }\n}\n\nvalidator.isRequired = makeRequirable(validator)\n```","kind":"module","name":"makeRequirable","params":[{"type":{"names":["function"]},"description":"a validator function","name":"validator"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if designated prop is not provided"}],"longname":"module:makeRequirable","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/makeRequirable.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/makeRequirable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/makeRequirable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/makeRequirable.ts').default","esPath":"@instructure/ui-prop-types/es/makeRequirable","themePath":"packages/ui-prop-types/src/makeRequirable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","id":"makeRequirable","title":"makeRequirable"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Given a validator function, extends the validator functionality to also\n * ensure that the prop has been provided if `.isRequired` is specified.\n *\n * ```js-code\n * function validator (props, propName, componentName) {\n * const propValue = props[propName]\n * if (propValue === 'purple') {\n * return new Error(`Purple is not accepted in ${componentName}!`)\n * }\n * }\n *\n * validator.isRequired = makeRequirable(validator)\n * ```\n * @module makeRequirable\n * @param {function} validator - a validator function\n * @returns {function} A function that returns Error if designated prop is not provided\n */","meta":{"filename":"smxmacxn6s33btysgbuy9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a validator function, extends the validator functionality to also\nensure that the prop has been provided if `.isRequired` is specified.\n\n```js-code\nfunction validator (props, propName, componentName) {\n const propValue = props[propName]\n if (propValue === 'purple') {\n return new Error(`Purple is not accepted in ${componentName}!`)\n }\n}\n\nvalidator.isRequired = makeRequirable(validator)\n```","kind":"module","name":"makeRequirable","params":[{"type":{"names":["function"]},"description":"a validator function","name":"validator"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if designated prop is not provided"}],"longname":"module:makeRequirable","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/makeRequirable.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/makeRequirable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/makeRequirable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/makeRequirable.ts').default","esPath":"@instructure/ui-prop-types/es/makeRequirable","themePath":"packages/ui-prop-types/src/makeRequirable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","id":"makeRequirable","title":"makeRequirable"} \ No newline at end of file diff --git a/docs/makeThemeVars.json b/docs/makeThemeVars.json index f17025d5f2..92dde836ff 100644 --- a/docs/makeThemeVars.json +++ b/docs/makeThemeVars.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a prefix and a theme object, prepends the object keys with\n * the designated prefix and camel cases the concatenation.\n * @module makeThemeVars\n * @param {String} prefix - a string to prepend to object keys\n * @param {Object} vars - an object\n * @returns {Object} a modified object with prefixed keys\n */","meta":{"filename":"erm7bto8mune68btepqxdm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a prefix and a theme object, prepends the object keys with\nthe designated prefix and camel cases the concatenation.","kind":"module","name":"makeThemeVars","params":[{"type":{"names":["String"]},"description":"a string to prepend to object keys","name":"prefix"},{"type":{"names":["Object"]},"description":"an object","name":"vars"}],"returns":[{"type":{"names":["Object"]},"description":"a modified object with prefixed keys"}],"longname":"module:makeThemeVars","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/makeThemeVars.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/makeThemeVars","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/makeThemeVars.ts').default","esPath":"@instructure/emotion/es/styleUtils/makeThemeVars","themePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","id":"makeThemeVars","title":"makeThemeVars"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a prefix and a theme object, prepends the object keys with\n * the designated prefix and camel cases the concatenation.\n * @module makeThemeVars\n * @param {String} prefix - a string to prepend to object keys\n * @param {Object} vars - an object\n * @returns {Object} a modified object with prefixed keys\n */","meta":{"filename":"fgibiysll2vm1l0jkkb8z.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a prefix and a theme object, prepends the object keys with\nthe designated prefix and camel cases the concatenation.","kind":"module","name":"makeThemeVars","params":[{"type":{"names":["String"]},"description":"a string to prepend to object keys","name":"prefix"},{"type":{"names":["Object"]},"description":"an object","name":"vars"}],"returns":[{"type":{"names":["Object"]},"description":"a modified object with prefixed keys"}],"longname":"module:makeThemeVars","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/makeThemeVars.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/makeThemeVars","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/makeThemeVars.ts').default","esPath":"@instructure/emotion/es/styleUtils/makeThemeVars","themePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","id":"makeThemeVars","title":"makeThemeVars"} \ No newline at end of file diff --git a/docs/matchComponentTypes.json b/docs/matchComponentTypes.json index 11433805df..441791804f 100644 --- a/docs/matchComponentTypes.json +++ b/docs/matchComponentTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Check if a React component instance (React element) matches one of the\n * specified types.\n *\n * @module matchComponentTypes\n * @param {ReactElement|any} componentInstance\n * @param {Array} types an array of React components\n * @returns {Boolean} true if the component matches at least one of the types\n */","meta":{"filename":"4jwwlfjvbbffynwa99i1ls.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Check if a React component instance (React element) matches one of the\nspecified types.","kind":"module","name":"matchComponentTypes","params":[{"type":{"names":["ReactElement","any"]},"name":"componentInstance"},{"type":{"names":["Array"]},"description":"an array of React components","name":"types"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the component matches at least one of the types"}],"longname":"module:matchComponentTypes","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/matchComponentTypes.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/matchComponentTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/matchComponentTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/matchComponentTypes.ts').default","esPath":"@instructure/ui-react-utils/es/matchComponentTypes","themePath":"packages/ui-react-utils/src/matchComponentTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","id":"matchComponentTypes","title":"matchComponentTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Check if a React component instance (React element) matches one of the\n * specified types.\n *\n * @module matchComponentTypes\n * @param {ReactElement|any} componentInstance\n * @param {Array} types an array of React components\n * @returns {Boolean} true if the component matches at least one of the types\n */","meta":{"filename":"s77jybxacyk2re01fsdgr.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Check if a React component instance (React element) matches one of the\nspecified types.","kind":"module","name":"matchComponentTypes","params":[{"type":{"names":["ReactElement","any"]},"name":"componentInstance"},{"type":{"names":["Array"]},"description":"an array of React components","name":"types"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the component matches at least one of the types"}],"longname":"module:matchComponentTypes","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/matchComponentTypes.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/matchComponentTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/matchComponentTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/matchComponentTypes.ts').default","esPath":"@instructure/ui-react-utils/es/matchComponentTypes","themePath":"packages/ui-react-utils/src/matchComponentTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","id":"matchComponentTypes","title":"matchComponentTypes"} \ No newline at end of file diff --git a/docs/matchMedia.json b/docs/matchMedia.json index dc162eec36..8bc0750278 100644 --- a/docs/matchMedia.json +++ b/docs/matchMedia.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Wrapper function for window.matchMedia\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia\n * @module matchMedia\n * @param {string} query - media query string\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @returns {Object} a media query list object\n */","meta":{"filename":"jzxhkpsbubwgh5el65hvn.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nWrapper function for window.matchMedia\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia","kind":"module","name":"matchMedia","params":[{"type":{"names":["string"]},"description":"media query string","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Object"]},"description":"a media query list object"}],"longname":"module:matchMedia","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/matchMedia.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/matchMedia.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/matchMedia","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/matchMedia.ts').default","esPath":"@instructure/ui-dom-utils/es/matchMedia","themePath":"packages/ui-dom-utils/src/matchMedia.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","id":"matchMedia","title":"matchMedia"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Wrapper function for window.matchMedia\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia\n * @module matchMedia\n * @param {string} query - media query string\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @returns {Object} a media query list object\n */","meta":{"filename":"dhjhs6xocg8nrcvpx455p.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nWrapper function for window.matchMedia\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia","kind":"module","name":"matchMedia","params":[{"type":{"names":["string"]},"description":"media query string","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Object"]},"description":"a media query list object"}],"longname":"module:matchMedia","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/matchMedia.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/matchMedia.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/matchMedia","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/matchMedia.ts').default","esPath":"@instructure/ui-dom-utils/es/matchMedia","themePath":"packages/ui-dom-utils/src/matchMedia.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","id":"matchMedia","title":"matchMedia"} \ No newline at end of file diff --git a/docs/mergeDeep.json b/docs/mergeDeep.json index a5ee379ccf..1f695212db 100644 --- a/docs/mergeDeep.json +++ b/docs/mergeDeep.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Deep merge N objects into a single result object.\n * Merging creates a new object, so that none of the arguments are modified.\n *\n * @module mergeDeep\n *\n * @param {Object} args objects to merge\n * @returns {Object} a new object with items from all arguments\n */","meta":{"filename":"5rwmbmnh0ktc1xcv7kx4so.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deep merge N objects into a single result object.\nMerging creates a new object, so that none of the arguments are modified.","kind":"module","name":"mergeDeep","params":[{"type":{"names":["Object"]},"description":"objects to merge","name":"args"}],"returns":[{"type":{"names":["Object"]},"description":"a new object with items from all arguments"}],"longname":"module:mergeDeep","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/mergeDeep.ts","extension":".ts","srcPath":"packages/ui-utils/src/mergeDeep.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/mergeDeep","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/mergeDeep.ts').default","esPath":"@instructure/ui-utils/es/mergeDeep","themePath":"packages/ui-utils/src/mergeDeep.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","id":"mergeDeep","title":"mergeDeep"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Deep merge N objects into a single result object.\n * Merging creates a new object, so that none of the arguments are modified.\n *\n * @module mergeDeep\n *\n * @param {Object} args objects to merge\n * @returns {Object} a new object with items from all arguments\n */","meta":{"filename":"6sa87p4bfdi8csm0s4cjmk.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deep merge N objects into a single result object.\nMerging creates a new object, so that none of the arguments are modified.","kind":"module","name":"mergeDeep","params":[{"type":{"names":["Object"]},"description":"objects to merge","name":"args"}],"returns":[{"type":{"names":["Object"]},"description":"a new object with items from all arguments"}],"longname":"module:mergeDeep","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/mergeDeep.ts","extension":".ts","srcPath":"packages/ui-utils/src/mergeDeep.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/mergeDeep","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/mergeDeep.ts').default","esPath":"@instructure/ui-utils/es/mergeDeep","themePath":"packages/ui-utils/src/mergeDeep.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","id":"mergeDeep","title":"mergeDeep"} \ No newline at end of file diff --git a/docs/mirrorPlacement.json b/docs/mirrorPlacement.json index e813e67fcf..38cb76bdb8 100644 --- a/docs/mirrorPlacement.json +++ b/docs/mirrorPlacement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n * Given a string or array of one or two placement values, mirrors the placement\n * vertically or horizontally based on the first value.\n *\n * Examples\n * ```js-code\n * mirrorPlacement('top start') // input\n * ['bottom', 'start'] // output\n *\n * mirrorPlacement('top start', ' ') // input\n * 'bottom start' //output\n * ```\n *\n * @param {string|Array} placement - a string of the form '`` ``' or array [``, ``]\n * @param {string} delimiter - when provided, a value with which the result array will be joined\n * @returns {string|Array} - an array of values or, if the delimiter was supplied, a string of\n * delimiter separated values\n *\n * @module mirrorPlacement\n **/","meta":{"filename":"r0amp8hlmkkm8q3ej8ywrl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a string or array of one or two placement values, mirrors the placement\nvertically or horizontally based on the first value.\n\nExamples\n```js-code\nmirrorPlacement('top start') // input\n['bottom', 'start'] // output\n\nmirrorPlacement('top start', ' ') // input\n'bottom start' //output\n```","params":[{"type":{"names":["string","Array"]},"description":"a string of the form '`` ``' or array [``, ``]","name":"placement"},{"type":{"names":["string"]},"description":"when provided, a value with which the result array will be joined","name":"delimiter"}],"returns":[{"type":{"names":["string","Array"]},"description":"- an array of values or, if the delimiter was supplied, a string of\n delimiter separated values"}],"kind":"module","name":"mirrorPlacement","longname":"module:mirrorPlacement","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/mirrorPlacement.ts","extension":".ts","srcPath":"packages/ui-position/src/mirrorPlacement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/mirrorPlacement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/mirrorPlacement.ts').default","esPath":"@instructure/ui-position/es/mirrorPlacement","themePath":"packages/ui-position/src/mirrorPlacement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","id":"mirrorPlacement","title":"mirrorPlacement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n * Given a string or array of one or two placement values, mirrors the placement\n * vertically or horizontally based on the first value.\n *\n * Examples\n * ```js-code\n * mirrorPlacement('top start') // input\n * ['bottom', 'start'] // output\n *\n * mirrorPlacement('top start', ' ') // input\n * 'bottom start' //output\n * ```\n *\n * @param {string|Array} placement - a string of the form '`` ``' or array [``, ``]\n * @param {string} delimiter - when provided, a value with which the result array will be joined\n * @returns {string|Array} - an array of values or, if the delimiter was supplied, a string of\n * delimiter separated values\n *\n * @module mirrorPlacement\n **/","meta":{"filename":"73h83dyx8c6terzbsejylq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a string or array of one or two placement values, mirrors the placement\nvertically or horizontally based on the first value.\n\nExamples\n```js-code\nmirrorPlacement('top start') // input\n['bottom', 'start'] // output\n\nmirrorPlacement('top start', ' ') // input\n'bottom start' //output\n```","params":[{"type":{"names":["string","Array"]},"description":"a string of the form '`` ``' or array [``, ``]","name":"placement"},{"type":{"names":["string"]},"description":"when provided, a value with which the result array will be joined","name":"delimiter"}],"returns":[{"type":{"names":["string","Array"]},"description":"- an array of values or, if the delimiter was supplied, a string of\n delimiter separated values"}],"kind":"module","name":"mirrorPlacement","longname":"module:mirrorPlacement","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/mirrorPlacement.ts","extension":".ts","srcPath":"packages/ui-position/src/mirrorPlacement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/mirrorPlacement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/mirrorPlacement.ts').default","esPath":"@instructure/ui-position/es/mirrorPlacement","themePath":"packages/ui-position/src/mirrorPlacement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","id":"mirrorPlacement","title":"mirrorPlacement"} \ No newline at end of file diff --git a/docs/mirrorShorthand.json b/docs/mirrorShorthand.json index 8920bc5ffc..e6ea3d0ee7 100644 --- a/docs/mirrorShorthand.json +++ b/docs/mirrorShorthand.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * @module mirrorShorthand\n */","meta":{"filename":"lx18gyjkdza37o29pjmrj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"mirrorShorthand","longname":"module:mirrorShorthand","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/mirrorShorthand","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/mirrorShorthand.ts').default","esPath":"@instructure/emotion/es/styleUtils/mirrorShorthand","themePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","id":"mirrorShorthand","title":"mirrorShorthand"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * @module mirrorShorthand\n */","meta":{"filename":"rqvg4f3e3pcmhvjtsee4l.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"mirrorShorthand","longname":"module:mirrorShorthand","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/mirrorShorthand","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/mirrorShorthand.ts').default","esPath":"@instructure/emotion/es/styleUtils/mirrorShorthand","themePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","id":"mirrorShorthand","title":"mirrorShorthand"} \ No newline at end of file diff --git a/docs/ms.json b/docs/ms.json index 617be47ba9..6912fde6be 100644 --- a/docs/ms.json +++ b/docs/ms.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value time combination (s, ms) to a number representing ms\n *\n * @module ms\n *\n * Example inputs:\n * - '100s'\n * - '20ms'\n *\n * @param {String|Number} val\n * @returns {Number} Returns numerical representation of milliseconds\n */","meta":{"filename":"cordafbv2eqbeggnforufv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value time combination (s, ms) to a number representing ms","kind":"module","name":"ms\n\nExample inputs:\n - '100s'\n - '20ms'","params":[{"type":{"names":["String","Number"]},"name":"val"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of milliseconds"}],"longname":"ms\n\nExample inputs:\n - '100s'\n - '20ms'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/ms.ts","extension":".ts","srcPath":"packages/ui-utils/src/ms.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/ms","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/ms.ts').default","esPath":"@instructure/ui-utils/es/ms","themePath":"packages/ui-utils/src/ms.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","id":"ms","title":"ms"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value time combination (s, ms) to a number representing ms\n *\n * @module ms\n *\n * Example inputs:\n * - '100s'\n * - '20ms'\n *\n * @param {String|Number} val\n * @returns {Number} Returns numerical representation of milliseconds\n */","meta":{"filename":"j57dxlec8pivturma837.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value time combination (s, ms) to a number representing ms","kind":"module","name":"ms\n\nExample inputs:\n - '100s'\n - '20ms'","params":[{"type":{"names":["String","Number"]},"name":"val"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of milliseconds"}],"longname":"ms\n\nExample inputs:\n - '100s'\n - '20ms'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/ms.ts","extension":".ts","srcPath":"packages/ui-utils/src/ms.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/ms","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/ms.ts').default","esPath":"@instructure/ui-utils/es/ms","themePath":"packages/ui-utils/src/ms.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","id":"ms","title":"ms"} \ No newline at end of file diff --git a/docs/omitProps.json b/docs/omitProps.json index c0f72f79a4..a450a04ac8 100644 --- a/docs/omitProps.json +++ b/docs/omitProps.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return an object with the remaining props after the given props are omitted.\n *\n * Automatically excludes the following props:\n * 'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'\n * @module omitProps\n * @param props The object to process\n * @param propsToOmit list disallowed prop keys or an object whose\n * keys will be omitted. If not specified the automatically excluded\n * props will be removed.\n * @param exclude an optional array of disallowed prop names to omit\n * @returns props object without the excluded props\n * @module omitProps\n */","meta":{"filename":"bh15jh6odisxrstxlmcyob.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return an object with the remaining props after the given props are omitted.\n\nAutomatically excludes the following props:\n'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'","kind":"module","name":"omitProps","params":[{"description":"The object to process","name":"props"},{"description":"list disallowed prop keys or an object whose\n keys will be omitted. If not specified the automatically excluded\n props will be removed.","name":"propsToOmit"},{"description":"an optional array of disallowed prop names to omit","name":"exclude"}],"returns":[{"description":"props object without the excluded props"}],"longname":"module:omitProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/omitProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/omitProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/omitProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/omitProps.ts').default","esPath":"@instructure/ui-react-utils/es/omitProps","themePath":"packages/ui-react-utils/src/omitProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","id":"omitProps","title":"omitProps"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return an object with the remaining props after the given props are omitted.\n *\n * Automatically excludes the following props:\n * 'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'\n * @module omitProps\n * @param props The object to process\n * @param propsToOmit list disallowed prop keys or an object whose\n * keys will be omitted. If not specified the automatically excluded\n * props will be removed.\n * @param exclude an optional array of disallowed prop names to omit\n * @returns props object without the excluded props\n * @module omitProps\n */","meta":{"filename":"5kxb3fpfe2990q2ru935h.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return an object with the remaining props after the given props are omitted.\n\nAutomatically excludes the following props:\n'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'","kind":"module","name":"omitProps","params":[{"description":"The object to process","name":"props"},{"description":"list disallowed prop keys or an object whose\n keys will be omitted. If not specified the automatically excluded\n props will be removed.","name":"propsToOmit"},{"description":"an optional array of disallowed prop names to omit","name":"exclude"}],"returns":[{"description":"props object without the excluded props"}],"longname":"module:omitProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/omitProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/omitProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/omitProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/omitProps.ts').default","esPath":"@instructure/ui-react-utils/es/omitProps","themePath":"packages/ui-react-utils/src/omitProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","id":"omitProps","title":"omitProps"} \ No newline at end of file diff --git a/docs/ownerDocument.json b/docs/ownerDocument.json index 1daa57414c..fbe841f5f2 100644 --- a/docs/ownerDocument.json +++ b/docs/ownerDocument.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieve the owner document of a specified element\n * @module ownerDocument\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Document | null} the owner document\n */","meta":{"filename":"c8h5i90evlk9v4mw8kbelk.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieve the owner document of a specified element","kind":"module","name":"ownerDocument","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Document","null"]},"description":"the owner document"}],"longname":"module:ownerDocument","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerDocument.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerDocument.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerDocument","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerDocument.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerDocument","themePath":"packages/ui-dom-utils/src/ownerDocument.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","id":"ownerDocument","title":"ownerDocument"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieve the owner document of a specified element\n * @module ownerDocument\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Document | null} the owner document\n */","meta":{"filename":"rfxex8tjparhpe0fmriss.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieve the owner document of a specified element","kind":"module","name":"ownerDocument","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Document","null"]},"description":"the owner document"}],"longname":"module:ownerDocument","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerDocument.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerDocument.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerDocument","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerDocument.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerDocument","themePath":"packages/ui-dom-utils/src/ownerDocument.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","id":"ownerDocument","title":"ownerDocument"} \ No newline at end of file diff --git a/docs/ownerWindow.json b/docs/ownerWindow.json index 41409f6223..2fc6d08127 100644 --- a/docs/ownerWindow.json +++ b/docs/ownerWindow.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Retrieve the owner window object associated with\n * the owner document of the specified element\n * @module ownerWindow\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Window | null } the owner window\n */","meta":{"filename":"jjrftv7ftyc2sg9j34ynb.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Retrieve the owner window object associated with\nthe owner document of the specified element","kind":"module","name":"ownerWindow","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Window","null"]},"description":"the owner window"}],"longname":"module:ownerWindow","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerWindow.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerWindow.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerWindow","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerWindow.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerWindow","themePath":"packages/ui-dom-utils/src/ownerWindow.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","id":"ownerWindow","title":"ownerWindow"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Retrieve the owner window object associated with\n * the owner document of the specified element\n * @module ownerWindow\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Window | null } the owner window\n */","meta":{"filename":"scdq2sylwgbf3llgz8n0h.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Retrieve the owner window object associated with\nthe owner document of the specified element","kind":"module","name":"ownerWindow","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Window","null"]},"description":"the owner window"}],"longname":"module:ownerWindow","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerWindow.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerWindow.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerWindow","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerWindow.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerWindow","themePath":"packages/ui-dom-utils/src/ownerWindow.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","id":"ownerWindow","title":"ownerWindow"} \ No newline at end of file diff --git a/docs/parseQuery.json b/docs/parseQuery.json index bf124a9cbe..967281d474 100644 --- a/docs/parseQuery.json +++ b/docs/parseQuery.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a query and an element, return a function that takes\n * size as an argument and returns an object consisting of\n * query names and a boolean true false if it matches.\n * @module parseQuery\n * @param {Object} query - an object consisting of query names\n * mapped to individual queries\n * @param {Document | Window | Node | null} el - component or DOM node\n * @returns {function} takes size {width, height} as an argument\n * and returns an object consisting of query names and boolean\n * true false if it matches\n */","meta":{"filename":"5icco7t9jz1gvdmqqqbet.js","lineno":5,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a query and an element, return a function that takes\nsize as an argument and returns an object consisting of\nquery names and a boolean true false if it matches.","kind":"module","name":"parseQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of query names\n mapped to individual queries","name":"query"},{"type":{"names":["Document","Window","Node","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["function"]},"description":"takes size {width, height} as an argument\n and returns an object consisting of query names and boolean\n true false if it matches"}],"longname":"module:parseQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/parseQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/parseQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/parseQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/parseQuery.ts').default","esPath":"@instructure/ui-responsive/es/parseQuery","themePath":"packages/ui-responsive/src/parseQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","id":"parseQuery","title":"parseQuery"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a query and an element, return a function that takes\n * size as an argument and returns an object consisting of\n * query names and a boolean true false if it matches.\n * @module parseQuery\n * @param {Object} query - an object consisting of query names\n * mapped to individual queries\n * @param {Document | Window | Node | null} el - component or DOM node\n * @returns {function} takes size {width, height} as an argument\n * and returns an object consisting of query names and boolean\n * true false if it matches\n */","meta":{"filename":"9k1fkosla7nwwoqfs8k8.js","lineno":5,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a query and an element, return a function that takes\nsize as an argument and returns an object consisting of\nquery names and a boolean true false if it matches.","kind":"module","name":"parseQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of query names\n mapped to individual queries","name":"query"},{"type":{"names":["Document","Window","Node","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["function"]},"description":"takes size {width, height} as an argument\n and returns an object consisting of query names and boolean\n true false if it matches"}],"longname":"module:parseQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/parseQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/parseQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/parseQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/parseQuery.ts').default","esPath":"@instructure/ui-responsive/es/parseQuery","themePath":"packages/ui-responsive/src/parseQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","id":"parseQuery","title":"parseQuery"} \ No newline at end of file diff --git a/docs/parseUnit.json b/docs/parseUnit.json index 35ace5d450..cf92224639 100644 --- a/docs/parseUnit.json +++ b/docs/parseUnit.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a CSS unit value combination into an array of type [ value, unit ]\n *\n * @module parseUnit\n *\n * Example inputs:\n * - '100px'\n * - '20rem'\n * - '10vh'\n * - '400vmin'\n *\n * @param {string|number} str\n * @returns {Array} Returns array of shape [ value, unit ] Unit is '' if it could\n * not be parsed\n */","meta":{"filename":"glkbrwcv65iw8mooejcnv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a CSS unit value combination into an array of type [ value, unit ]","kind":"module","name":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'","params":[{"type":{"names":["string","number"]},"name":"str"}],"returns":[{"type":{"names":["Array"]},"description":"Returns array of shape [ value, unit ] Unit is '' if it could\nnot be parsed"}],"longname":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/parseUnit.ts","extension":".ts","srcPath":"packages/ui-utils/src/parseUnit.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/parseUnit","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/parseUnit.ts').default","esPath":"@instructure/ui-utils/es/parseUnit","themePath":"packages/ui-utils/src/parseUnit.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","id":"parseUnit","title":"parseUnit"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a CSS unit value combination into an array of type [ value, unit ]\n *\n * @module parseUnit\n *\n * Example inputs:\n * - '100px'\n * - '20rem'\n * - '10vh'\n * - '400vmin'\n *\n * @param {string|number} str\n * @returns {Array} Returns array of shape [ value, unit ] Unit is '' if it could\n * not be parsed\n */","meta":{"filename":"2lev5ziokzq0324zkmdmyux.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a CSS unit value combination into an array of type [ value, unit ]","kind":"module","name":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'","params":[{"type":{"names":["string","number"]},"name":"str"}],"returns":[{"type":{"names":["Array"]},"description":"Returns array of shape [ value, unit ] Unit is '' if it could\nnot be parsed"}],"longname":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/parseUnit.ts","extension":".ts","srcPath":"packages/ui-utils/src/parseUnit.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/parseUnit","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/parseUnit.ts').default","esPath":"@instructure/ui-utils/es/parseUnit","themePath":"packages/ui-utils/src/parseUnit.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","id":"parseUnit","title":"parseUnit"} \ No newline at end of file diff --git a/docs/pascalize.json b/docs/pascalize.json index 81704a3ebb..24d162c942 100644 --- a/docs/pascalize.json +++ b/docs/pascalize.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a hyphenated or camel cased string to pascal case\n *\n * Example inputs:\n * - 'foo-bar'\n * - 'baz-qux'\n *\n * Example outputs:\n * - 'FooBar'\n * - 'BazQux'\n *\n * @module pascalize\n * @param {String} str\n * @returns {String} Returns pascal cased string\n */","meta":{"filename":"byxw2o86eysl9fywga2bn.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a hyphenated or camel cased string to pascal case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'FooBar'\n - 'BazQux'","kind":"module","name":"pascalize","params":[{"type":{"names":["String"]},"name":"str"}],"returns":[{"type":{"names":["String"]},"description":"Returns pascal cased string"}],"longname":"module:pascalize","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/pascalize.ts","extension":".ts","srcPath":"packages/ui-utils/src/pascalize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/pascalize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/pascalize.ts').default","esPath":"@instructure/ui-utils/es/pascalize","themePath":"packages/ui-utils/src/pascalize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","id":"pascalize","title":"pascalize"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a hyphenated or camel cased string to pascal case\n *\n * Example inputs:\n * - 'foo-bar'\n * - 'baz-qux'\n *\n * Example outputs:\n * - 'FooBar'\n * - 'BazQux'\n *\n * @module pascalize\n * @param {String} str\n * @returns {String} Returns pascal cased string\n */","meta":{"filename":"cmj7nvw8qy2k2iu97uhx2.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a hyphenated or camel cased string to pascal case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'FooBar'\n - 'BazQux'","kind":"module","name":"pascalize","params":[{"type":{"names":["String"]},"name":"str"}],"returns":[{"type":{"names":["String"]},"description":"Returns pascal cased string"}],"longname":"module:pascalize","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/pascalize.ts","extension":".ts","srcPath":"packages/ui-utils/src/pascalize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/pascalize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/pascalize.ts').default","esPath":"@instructure/ui-utils/es/pascalize","themePath":"packages/ui-utils/src/pascalize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","id":"pascalize","title":"pascalize"} \ No newline at end of file diff --git a/docs/pickProps.json b/docs/pickProps.json index d33f615cec..cc6b88448a 100644 --- a/docs/pickProps.json +++ b/docs/pickProps.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return a props object with only specified propTypes.\n * @module pickProps\n * @param {Object} props React component props\n * @param {Object|Array} propTypesOrAllowedPropList React component propTypes or the list of allowed prop keys\n * @param {Array} include an optional array of prop names to include\n * @returns {Object} props object with only the included props\n * @module pickProps\n */","meta":{"filename":"tmqgd02qqkkemdw79q3af.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return a props object with only specified propTypes.","kind":"module","name":"pickProps","params":[{"type":{"names":["Object"]},"description":"React component props","name":"props"},{"type":{"names":["Object","Array."]},"description":"React component propTypes or the list of allowed prop keys","name":"propTypesOrAllowedPropList"},{"type":{"names":["Array"]},"description":"an optional array of prop names to include","name":"include"}],"returns":[{"type":{"names":["Object"]},"description":"props object with only the included props"}],"longname":"module:pickProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/pickProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/pickProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/pickProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/pickProps.ts').default","esPath":"@instructure/ui-react-utils/es/pickProps","themePath":"packages/ui-react-utils/src/pickProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","id":"pickProps","title":"pickProps"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return a props object with only specified propTypes.\n * @module pickProps\n * @param {Object} props React component props\n * @param {Object|Array} propTypesOrAllowedPropList React component propTypes or the list of allowed prop keys\n * @param {Array} include an optional array of prop names to include\n * @returns {Object} props object with only the included props\n * @module pickProps\n */","meta":{"filename":"u0fndksdyw9nz1sm0m3fd.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return a props object with only specified propTypes.","kind":"module","name":"pickProps","params":[{"type":{"names":["Object"]},"description":"React component props","name":"props"},{"type":{"names":["Object","Array."]},"description":"React component propTypes or the list of allowed prop keys","name":"propTypesOrAllowedPropList"},{"type":{"names":["Array"]},"description":"an optional array of prop names to include","name":"include"}],"returns":[{"type":{"names":["Object"]},"description":"props object with only the included props"}],"longname":"module:pickProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/pickProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/pickProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/pickProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/pickProps.ts').default","esPath":"@instructure/ui-react-utils/es/pickProps","themePath":"packages/ui-react-utils/src/pickProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","id":"pickProps","title":"pickProps"} \ No newline at end of file diff --git a/docs/px.json b/docs/px.json index f6c7677ae6..0400913398 100644 --- a/docs/px.json +++ b/docs/px.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value size combination (em, rem, px) to a number representing px\n *\n * Example inputs:\n * - '100rem'\n * - '20em'\n * - '40px'\n *\n * @module px\n *\n * @param {String|number} val The value to look up. If it's a number its just returned as is.\n * @param {Document|Window|Node|React.ReactElement |React.Component|null} el - containing element, for context measure is em (defaults to `document.body`)\n * @returns {Number} Returns numerical representation of pixels\n */","meta":{"filename":"2trwc1rd5cyw4pf9raq2zf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value size combination (em, rem, px) to a number representing px\n\nExample inputs:\n - '100rem'\n - '20em'\n - '40px'","kind":"module","name":"px","params":[{"type":{"names":["String","number"]},"description":"The value to look up. If it's a number its just returned as is.","name":"val"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component","null"]},"description":"containing element, for context measure is em (defaults to `document.body`)","name":"el"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of pixels"}],"longname":"module:px","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/px.ts","extension":".ts","srcPath":"packages/ui-utils/src/px.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/px","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/px.ts').default","esPath":"@instructure/ui-utils/es/px","themePath":"packages/ui-utils/src/px.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","id":"px","title":"px"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value size combination (em, rem, px) to a number representing px\n *\n * Example inputs:\n * - '100rem'\n * - '20em'\n * - '40px'\n *\n * @module px\n *\n * @param {String|number} val The value to look up. If it's a number its just returned as is.\n * @param {Document|Window|Node|React.ReactElement |React.Component|null} el - containing element, for context measure is em (defaults to `document.body`)\n * @returns {Number} Returns numerical representation of pixels\n */","meta":{"filename":"d9ljjas5myljxjbe7v9rr.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value size combination (em, rem, px) to a number representing px\n\nExample inputs:\n - '100rem'\n - '20em'\n - '40px'","kind":"module","name":"px","params":[{"type":{"names":["String","number"]},"description":"The value to look up. If it's a number its just returned as is.","name":"val"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component","null"]},"description":"containing element, for context measure is em (defaults to `document.body`)","name":"el"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of pixels"}],"longname":"module:px","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/px.ts","extension":".ts","srcPath":"packages/ui-utils/src/px.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/px","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/px.ts').default","esPath":"@instructure/ui-utils/es/px","themePath":"packages/ui-utils/src/px.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","id":"px","title":"px"} \ No newline at end of file diff --git a/docs/requestAnimationFrame.json b/docs/requestAnimationFrame.json index d0bf4e0f09..b19153848c 100644 --- a/docs/requestAnimationFrame.json +++ b/docs/requestAnimationFrame.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * If DOM is usable, returns a function wrapper for\n * window.requestAnimationFrame. Otherwise sets\n * a manual timeout.\n * @module requestAnimationFrame\n *\n * @returns {function} requestAnimationFrame takes a callback function as an argument and returns a cancel method\n */","meta":{"filename":"5ns1gmvf7ogvdpqnvvtoac.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nIf DOM is usable, returns a function wrapper for\nwindow.requestAnimationFrame. Otherwise sets\na manual timeout.","kind":"module","name":"requestAnimationFrame","returns":[{"type":{"names":["function"]},"description":"requestAnimationFrame takes a callback function as an argument and returns a cancel method"}],"longname":"module:requestAnimationFrame","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/requestAnimationFrame","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/requestAnimationFrame.ts').default","esPath":"@instructure/ui-dom-utils/es/requestAnimationFrame","themePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","id":"requestAnimationFrame","title":"requestAnimationFrame"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * If DOM is usable, returns a function wrapper for\n * window.requestAnimationFrame. Otherwise sets\n * a manual timeout.\n * @module requestAnimationFrame\n *\n * @returns {function} requestAnimationFrame takes a callback function as an argument and returns a cancel method\n */","meta":{"filename":"mw92fklr9c29c59h3zw7w.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nIf DOM is usable, returns a function wrapper for\nwindow.requestAnimationFrame. Otherwise sets\na manual timeout.","kind":"module","name":"requestAnimationFrame","returns":[{"type":{"names":["function"]},"description":"requestAnimationFrame takes a callback function as an argument and returns a cancel method"}],"longname":"module:requestAnimationFrame","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/requestAnimationFrame","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/requestAnimationFrame.ts').default","esPath":"@instructure/ui-dom-utils/es/requestAnimationFrame","themePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","id":"requestAnimationFrame","title":"requestAnimationFrame"} \ No newline at end of file diff --git a/docs/scopeTab.json b/docs/scopeTab.json index eed799b1b1..d40aee1b12 100644 --- a/docs/scopeTab.json +++ b/docs/scopeTab.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Scope tab in order to trap focus within a specified\n * element.\n * @module scopeTab\n * @param {ReactElement|DOMNode} element\n * @param {Event} event the DOM Event that was fired\n * @param {function} function executed when leaving final tabbable instead of the default behavior\n */","meta":{"filename":"1rz2z539zud6d05hn7h359.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nScope tab in order to trap focus within a specified\nelement.","kind":"module","name":"scopeTab","params":[{"type":{"names":["ReactElement","DOMNode"]},"name":"element"},{"type":{"names":["Event"]},"description":"the DOM Event that was fired","name":"event"},{"type":{"names":["function"]},"description":"executed when leaving final tabbable instead of the default behavior","name":"function"}],"longname":"module:scopeTab","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/scopeTab.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/scopeTab.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/scopeTab","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/scopeTab.ts').default","esPath":"@instructure/ui-a11y-utils/es/scopeTab","themePath":"packages/ui-a11y-utils/src/scopeTab.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","id":"scopeTab","title":"scopeTab"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Scope tab in order to trap focus within a specified\n * element.\n * @module scopeTab\n * @param {ReactElement|DOMNode} element\n * @param {Event} event the DOM Event that was fired\n * @param {function} function executed when leaving final tabbable instead of the default behavior\n */","meta":{"filename":"a3jvl270vb97t3475elx6.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nScope tab in order to trap focus within a specified\nelement.","kind":"module","name":"scopeTab","params":[{"type":{"names":["ReactElement","DOMNode"]},"name":"element"},{"type":{"names":["Event"]},"description":"the DOM Event that was fired","name":"event"},{"type":{"names":["function"]},"description":"executed when leaving final tabbable instead of the default behavior","name":"function"}],"longname":"module:scopeTab","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/scopeTab.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/scopeTab.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/scopeTab","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/scopeTab.ts').default","esPath":"@instructure/ui-a11y-utils/es/scopeTab","themePath":"packages/ui-a11y-utils/src/scopeTab.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","id":"scopeTab","title":"scopeTab"} \ No newline at end of file diff --git a/docs/shallowEqual.json b/docs/shallowEqual.json index 76a5624084..37e23cd172 100644 --- a/docs/shallowEqual.json +++ b/docs/shallowEqual.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Performs equality by iterating through keys on an object and returning false\n * when any key has values which are not strictly equal between the arguments.\n *\n * @module shallowEqual\n *\n * @param {Object} objA\n * @param {Object} objB\n * @returns {Boolean} Returns true when the values of all keys are strictly equal\n */","meta":{"filename":"xops344hbdk40uwyndaxi.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Performs equality by iterating through keys on an object and returning false\nwhen any key has values which are not strictly equal between the arguments.","kind":"module","name":"shallowEqual","params":[{"type":{"names":["Object"]},"name":"objA"},{"type":{"names":["Object"]},"name":"objB"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true when the values of all keys are strictly equal"}],"longname":"module:shallowEqual","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/shallowEqual.ts","extension":".ts","srcPath":"packages/ui-utils/src/shallowEqual.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/shallowEqual","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/shallowEqual.ts').default","esPath":"@instructure/ui-utils/es/shallowEqual","themePath":"packages/ui-utils/src/shallowEqual.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","id":"shallowEqual","title":"shallowEqual"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Performs equality by iterating through keys on an object and returning false\n * when any key has values which are not strictly equal between the arguments.\n *\n * @module shallowEqual\n *\n * @param {Object} objA\n * @param {Object} objB\n * @returns {Boolean} Returns true when the values of all keys are strictly equal\n */","meta":{"filename":"bg2pn6x3efrbahq90dil.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Performs equality by iterating through keys on an object and returning false\nwhen any key has values which are not strictly equal between the arguments.","kind":"module","name":"shallowEqual","params":[{"type":{"names":["Object"]},"name":"objA"},{"type":{"names":["Object"]},"name":"objB"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true when the values of all keys are strictly equal"}],"longname":"module:shallowEqual","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/shallowEqual.ts","extension":".ts","srcPath":"packages/ui-utils/src/shallowEqual.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/shallowEqual","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/shallowEqual.ts').default","esPath":"@instructure/ui-utils/es/shallowEqual","themePath":"packages/ui-utils/src/shallowEqual.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","id":"shallowEqual","title":"shallowEqual"} \ No newline at end of file diff --git a/docs/textDirectionContextConsumer.json b/docs/textDirectionContextConsumer.json index b1b1459f55..bb0c0bd666 100644 --- a/docs/textDirectionContextConsumer.json +++ b/docs/textDirectionContextConsumer.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * A decorator or higher order component that supplies the text direction to\n * components.\n *\n * As a HOC:\n *\n * ```js-code\n * import { textDirectionContextConsumer } from '@instructure/ui-i18n'\n *\n * class Example extends React.Component {\n * render () {\n * return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n * }\n * }\n *\n * export default textDirectionContextConsumer()(Example)\n * ```\n *\n * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\n * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\n * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\n * textDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\n * if it is not present.\n *\n * @module textDirectionContextConsumer\n * @return The decorator that composes the textDirectionContextConsumer component.\n */","meta":{"filename":"lojgpf0yqxc9pelf9pdcc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that supplies the text direction to\ncomponents.\n\nAs a HOC:\n\n```js-code\nimport { textDirectionContextConsumer } from '@instructure/ui-i18n'\n\nclass Example extends React.Component {\n render () {\n return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n }\n}\n\nexport default textDirectionContextConsumer()(Example)\n```\n\nWhen used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\nthe direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\nthe direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\ntextDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\nif it is not present.","kind":"module","name":"textDirectionContextConsumer","returns":[{"description":"The decorator that composes the textDirectionContextConsumer component."}],"longname":"module:textDirectionContextConsumer","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","extension":".tsx","srcPath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/textDirectionContextConsumer","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/textDirectionContextConsumer.tsx').default","esPath":"@instructure/ui-i18n/es/textDirectionContextConsumer","themePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","id":"textDirectionContextConsumer","title":"textDirectionContextConsumer"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * A decorator or higher order component that supplies the text direction to\n * components.\n *\n * As a HOC:\n *\n * ```js-code\n * import { textDirectionContextConsumer } from '@instructure/ui-i18n'\n *\n * class Example extends React.Component {\n * render () {\n * return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n * }\n * }\n *\n * export default textDirectionContextConsumer()(Example)\n * ```\n *\n * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\n * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\n * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\n * textDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\n * if it is not present.\n *\n * @module textDirectionContextConsumer\n * @return The decorator that composes the textDirectionContextConsumer component.\n */","meta":{"filename":"nt6ecnxolwb5zvghr98wyh.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that supplies the text direction to\ncomponents.\n\nAs a HOC:\n\n```js-code\nimport { textDirectionContextConsumer } from '@instructure/ui-i18n'\n\nclass Example extends React.Component {\n render () {\n return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n }\n}\n\nexport default textDirectionContextConsumer()(Example)\n```\n\nWhen used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\nthe direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\nthe direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\ntextDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\nif it is not present.","kind":"module","name":"textDirectionContextConsumer","returns":[{"description":"The decorator that composes the textDirectionContextConsumer component."}],"longname":"module:textDirectionContextConsumer","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","extension":".tsx","srcPath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/textDirectionContextConsumer","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/textDirectionContextConsumer.tsx').default","esPath":"@instructure/ui-i18n/es/textDirectionContextConsumer","themePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","id":"textDirectionContextConsumer","title":"textDirectionContextConsumer"} \ No newline at end of file diff --git a/docs/transformSelection.json b/docs/transformSelection.json index a5656da1ab..c80a8b412b 100644 --- a/docs/transformSelection.json +++ b/docs/transformSelection.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * transformSelection - Calculate the resulting text selection\n * of a changing text-containing HTML element\n * @module transformSelection\n * @param {HTMLElement} element - HTML element with selection capabilities\n * @param {string} cleanedValue - new value that will be given to the HTML element\n * @return {Object} resulting selection values\n */","meta":{"filename":"3rtpq4blmudhh9hyhir4x.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\ntransformSelection - Calculate the resulting text selection\nof a changing text-containing HTML element","kind":"module","name":"transformSelection","params":[{"type":{"names":["HTMLElement"]},"description":"HTML element with selection capabilities","name":"element"},{"type":{"names":["string"]},"description":"new value that will be given to the HTML element","name":"cleanedValue"}],"returns":[{"type":{"names":["Object"]},"description":"resulting selection values"}],"longname":"module:transformSelection","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/transformSelection.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/transformSelection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/transformSelection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/transformSelection.ts').default","esPath":"@instructure/ui-dom-utils/es/transformSelection","themePath":"packages/ui-dom-utils/src/transformSelection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","id":"transformSelection","title":"transformSelection"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * transformSelection - Calculate the resulting text selection\n * of a changing text-containing HTML element\n * @module transformSelection\n * @param {HTMLElement} element - HTML element with selection capabilities\n * @param {string} cleanedValue - new value that will be given to the HTML element\n * @return {Object} resulting selection values\n */","meta":{"filename":"0tlk7ie5kx94fg22pfrulh.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\ntransformSelection - Calculate the resulting text selection\nof a changing text-containing HTML element","kind":"module","name":"transformSelection","params":[{"type":{"names":["HTMLElement"]},"description":"HTML element with selection capabilities","name":"element"},{"type":{"names":["string"]},"description":"new value that will be given to the HTML element","name":"cleanedValue"}],"returns":[{"type":{"names":["Object"]},"description":"resulting selection values"}],"longname":"module:transformSelection","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/transformSelection.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/transformSelection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/transformSelection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/transformSelection.ts').default","esPath":"@instructure/ui-dom-utils/es/transformSelection","themePath":"packages/ui-dom-utils/src/transformSelection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","id":"transformSelection","title":"transformSelection"} \ No newline at end of file diff --git a/docs/uid.json b/docs/uid.json index 05488a41a2..10d7ac44f0 100644 --- a/docs/uid.json +++ b/docs/uid.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Generate a unique (CSS-safe) id string\n *\n * @module uid\n * @param {String} prefix a string to prefix the id for debugging in non-production env\n * @param {Number} length id length (in characters, minus the prefix). Default is 12\n * @returns {String} a unique id\n */","meta":{"filename":"aa1rb7pm0bv7k7sg77qy3v.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Generate a unique (CSS-safe) id string","kind":"module","name":"uid","params":[{"type":{"names":["String"]},"description":"a string to prefix the id for debugging in non-production env","name":"prefix"},{"type":{"names":["Number"]},"description":"id length (in characters, minus the prefix). Default is 12","name":"length"}],"returns":[{"type":{"names":["String"]},"description":"a unique id"}],"longname":"module:uid","undocumented":false,"category":"utilities","relativePath":"packages/uid/src/uid.ts","extension":".ts","srcPath":"packages/uid/src/uid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","packageName":"@instructure/uid","requirePath":"@instructure/uid/lib/uid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/uid/src/uid.ts').default","esPath":"@instructure/uid/es/uid","themePath":"packages/uid/src/uid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","id":"uid","title":"uid"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Generate a unique (CSS-safe) id string\n *\n * @module uid\n * @param {String} prefix a string to prefix the id for debugging in non-production env\n * @param {Number} length id length (in characters, minus the prefix). Default is 12\n * @returns {String} a unique id\n */","meta":{"filename":"qedmbb3vdspkgshfjssfm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Generate a unique (CSS-safe) id string","kind":"module","name":"uid","params":[{"type":{"names":["String"]},"description":"a string to prefix the id for debugging in non-production env","name":"prefix"},{"type":{"names":["Number"]},"description":"id length (in characters, minus the prefix). Default is 12","name":"length"}],"returns":[{"type":{"names":["String"]},"description":"a unique id"}],"longname":"module:uid","undocumented":false,"category":"utilities","relativePath":"packages/uid/src/uid.ts","extension":".ts","srcPath":"packages/uid/src/uid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","packageName":"@instructure/uid","requirePath":"@instructure/uid/lib/uid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/uid/src/uid.ts').default","esPath":"@instructure/uid/es/uid","themePath":"packages/uid/src/uid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","id":"uid","title":"uid"} \ No newline at end of file diff --git a/docs/windowMessageListener.json b/docs/windowMessageListener.json index 22fe75e49e..34d1255ae4 100644 --- a/docs/windowMessageListener.json +++ b/docs/windowMessageListener.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * A decorator or higher order component that provides methods\n * for cross-origin communication (between iframes/windows).\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage\n * @module windowMessageListener\n * @param {Function} messageHandler a handler for messages receieved by the component\n * @param {Function} validSource an optional function that would restrict message handling to a specified source.\n * @returns {Function} a function that decorates a React component with the behavior\n */","meta":{"filename":"yjrt3w8qeqkjz3ocqzu1hp.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A decorator or higher order component that provides methods\nfor cross-origin communication (between iframes/windows).\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage","kind":"module","name":"windowMessageListener","params":[{"type":{"names":["function"]},"description":"a handler for messages receieved by the component","name":"messageHandler"},{"type":{"names":["function"]},"description":"an optional function that would restrict message handling to a specified source.","name":"validSource"}],"returns":[{"type":{"names":["function"]},"description":"a function that decorates a React component with the behavior"}],"longname":"module:windowMessageListener","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/windowMessageListener.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/windowMessageListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/windowMessageListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/windowMessageListener.ts').default","esPath":"@instructure/ui-react-utils/es/windowMessageListener","themePath":"packages/ui-react-utils/src/windowMessageListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","id":"windowMessageListener","title":"windowMessageListener"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * A decorator or higher order component that provides methods\n * for cross-origin communication (between iframes/windows).\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage\n * @module windowMessageListener\n * @param {Function} messageHandler a handler for messages receieved by the component\n * @param {Function} validSource an optional function that would restrict message handling to a specified source.\n * @returns {Function} a function that decorates a React component with the behavior\n */","meta":{"filename":"i8qsztlcwdoqybzgivyiz9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A decorator or higher order component that provides methods\nfor cross-origin communication (between iframes/windows).\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage","kind":"module","name":"windowMessageListener","params":[{"type":{"names":["function"]},"description":"a handler for messages receieved by the component","name":"messageHandler"},{"type":{"names":["function"]},"description":"an optional function that would restrict message handling to a specified source.","name":"validSource"}],"returns":[{"type":{"names":["function"]},"description":"a function that decorates a React component with the behavior"}],"longname":"module:windowMessageListener","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/windowMessageListener.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/windowMessageListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/windowMessageListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/windowMessageListener.ts').default","esPath":"@instructure/ui-react-utils/es/windowMessageListener","themePath":"packages/ui-react-utils/src/windowMessageListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","id":"windowMessageListener","title":"windowMessageListener"} \ No newline at end of file diff --git a/docs/withStyle.json b/docs/withStyle.json index 93a232b5d5..09dd5f1874 100644 --- a/docs/withStyle.json +++ b/docs/withStyle.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n *\n * A decorator or higher order component that makes a component themeable.\n *\n * It adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n *\n * As a HOC:\n *\n * ```js-code\n * import { withStyle, jsx } from '@instructure/emotion'\n * import generateStyle from './styles'\n * import generateComponentTheme from './theme'\n *\n * export default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n * ```\n *\n * Themeable components inject their themed styles into the document\n * when they are mounted.\n *\n * ### Applying themes\n *\n * A themeable component’s theme can be configured via wrapping it in an\n * [InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\n * explicitly via its `themeOverride` prop.\n *\n * InstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\n * These variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n *\n * With the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n *\n * See more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n *\n * ```js-code\n * // ExampleComponent/theme.js\n * const generateComponentTheme = (theme) => {\n * const { colors } = theme\n *\n * const componentVariables = {\n * background: colors?.backgroundMedium,\n * color: colors?.textDarkest,\n *\n * hoverColor: colors?.textLightest,\n * hoverBackground: colors?.backgroundDarkest\n * }\n *\n * return componentVariables\n * }\n * export default generateComponentTheme\n * ```\n *\n * ```jsx-code\n * {// global theme override}\n * \n * {// component theme override}\n * \n *\n * {// component theme override with function}\n * ({\n * hoverBackground: componentTheme.background,\n * activeBackground: currentTheme.colors.backgroundBrand\n * })} />\n * \n * ```\n *\n * @module withStyle\n *\n * @param {function} generateStyle - The function that returns the component's style object\n * @param {function} generateComponentTheme - The function that returns the component's theme variables object\n * @returns {ReactElement} The decorated WithStyle Component\n */","meta":{"filename":"ble5gipmb5ly7b7all3e4.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that makes a component themeable.\n\nIt adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n\nAs a HOC:\n\n```js-code\nimport { withStyle, jsx } from '@instructure/emotion'\nimport generateStyle from './styles'\nimport generateComponentTheme from './theme'\n\nexport default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n```\n\nThemeable components inject their themed styles into the document\nwhen they are mounted.\n\n### Applying themes\n\nA themeable component’s theme can be configured via wrapping it in an\n[InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\nexplicitly via its `themeOverride` prop.\n\nInstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\nThese variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n\nWith the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n\nSee more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n\n```js-code\n// ExampleComponent/theme.js\nconst generateComponentTheme = (theme) => {\n const { colors } = theme\n\n const componentVariables = {\n background: colors?.backgroundMedium,\n color: colors?.textDarkest,\n\n hoverColor: colors?.textLightest,\n hoverBackground: colors?.backgroundDarkest\n }\n\n return componentVariables\n}\nexport default generateComponentTheme\n```\n\n```jsx-code\n{// global theme override}\n\n {// component theme override}\n \n\n {// component theme override with function}\n ({\n hoverBackground: componentTheme.background,\n activeBackground: currentTheme.colors.backgroundBrand\n })} />\n\n```","kind":"module","name":"withStyle","params":[{"type":{"names":["function"]},"description":"The function that returns the component's style object","name":"generateStyle"},{"type":{"names":["function"]},"description":"The function that returns the component's theme variables object","name":"generateComponentTheme"}],"returns":[{"type":{"names":["ReactElement"]},"description":"The decorated WithStyle Component"}],"longname":"module:withStyle","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/withStyle.tsx","extension":".tsx","srcPath":"packages/emotion/src/withStyle.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/withStyle","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/withStyle.tsx').default","esPath":"@instructure/emotion/es/withStyle","themePath":"packages/emotion/src/withStyle.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","id":"withStyle","title":"withStyle"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n *\n * A decorator or higher order component that makes a component themeable.\n *\n * It adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n *\n * As a HOC:\n *\n * ```js-code\n * import { withStyle, jsx } from '@instructure/emotion'\n * import generateStyle from './styles'\n * import generateComponentTheme from './theme'\n *\n * export default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n * ```\n *\n * Themeable components inject their themed styles into the document\n * when they are mounted.\n *\n * ### Applying themes\n *\n * A themeable component’s theme can be configured via wrapping it in an\n * [InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\n * explicitly via its `themeOverride` prop.\n *\n * InstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\n * These variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n *\n * With the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n *\n * See more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n *\n * ```js-code\n * // ExampleComponent/theme.js\n * const generateComponentTheme = (theme) => {\n * const { colors } = theme\n *\n * const componentVariables = {\n * background: colors?.backgroundMedium,\n * color: colors?.textDarkest,\n *\n * hoverColor: colors?.textLightest,\n * hoverBackground: colors?.backgroundDarkest\n * }\n *\n * return componentVariables\n * }\n * export default generateComponentTheme\n * ```\n *\n * ```jsx-code\n * {// global theme override}\n * \n * {// component theme override}\n * \n *\n * {// component theme override with function}\n * ({\n * hoverBackground: componentTheme.background,\n * activeBackground: currentTheme.colors.backgroundBrand\n * })} />\n * \n * ```\n *\n * @module withStyle\n *\n * @param {function} generateStyle - The function that returns the component's style object\n * @param {function} generateComponentTheme - The function that returns the component's theme variables object\n * @returns {ReactElement} The decorated WithStyle Component\n */","meta":{"filename":"uw93mwk1s5miowe4jb64tp.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that makes a component themeable.\n\nIt adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n\nAs a HOC:\n\n```js-code\nimport { withStyle, jsx } from '@instructure/emotion'\nimport generateStyle from './styles'\nimport generateComponentTheme from './theme'\n\nexport default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n```\n\nThemeable components inject their themed styles into the document\nwhen they are mounted.\n\n### Applying themes\n\nA themeable component’s theme can be configured via wrapping it in an\n[InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\nexplicitly via its `themeOverride` prop.\n\nInstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\nThese variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n\nWith the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n\nSee more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n\n```js-code\n// ExampleComponent/theme.js\nconst generateComponentTheme = (theme) => {\n const { colors } = theme\n\n const componentVariables = {\n background: colors?.backgroundMedium,\n color: colors?.textDarkest,\n\n hoverColor: colors?.textLightest,\n hoverBackground: colors?.backgroundDarkest\n }\n\n return componentVariables\n}\nexport default generateComponentTheme\n```\n\n```jsx-code\n{// global theme override}\n\n {// component theme override}\n \n\n {// component theme override with function}\n ({\n hoverBackground: componentTheme.background,\n activeBackground: currentTheme.colors.backgroundBrand\n })} />\n\n```","kind":"module","name":"withStyle","params":[{"type":{"names":["function"]},"description":"The function that returns the component's style object","name":"generateStyle"},{"type":{"names":["function"]},"description":"The function that returns the component's theme variables object","name":"generateComponentTheme"}],"returns":[{"type":{"names":["ReactElement"]},"description":"The decorated WithStyle Component"}],"longname":"module:withStyle","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/withStyle.tsx","extension":".tsx","srcPath":"packages/emotion/src/withStyle.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/withStyle","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/withStyle.tsx').default","esPath":"@instructure/emotion/es/withStyle","themePath":"packages/emotion/src/withStyle.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","id":"withStyle","title":"withStyle"} \ No newline at end of file diff --git a/docs/within.json b/docs/within.json index e42694bbf1..3afbb425a0 100644 --- a/docs/within.json +++ b/docs/within.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Determines if one numerical value (a) is within a designated range (diff) of another (b)\n *\n * @module within\n *\n * @param {number} a\n * @param {number} b\n * @param {number} [diff=1]\n * @returns {Boolean} Returns true if a is within the diff range of b\n */","meta":{"filename":"idytpe84qsk801qkwnpl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Determines if one numerical value (a) is within a designated range (diff) of another (b)","kind":"module","name":"within","params":[{"type":{"names":["number"]},"name":"a"},{"type":{"names":["number"]},"name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"name":"diff"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true if a is within the diff range of b"}],"longname":"module:within","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/within.ts","extension":".ts","srcPath":"packages/ui-utils/src/within.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/within","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/within.ts').default","esPath":"@instructure/ui-utils/es/within","themePath":"packages/ui-utils/src/within.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","id":"within","title":"within"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Determines if one numerical value (a) is within a designated range (diff) of another (b)\n *\n * @module within\n *\n * @param {number} a\n * @param {number} b\n * @param {number} [diff=1]\n * @returns {Boolean} Returns true if a is within the diff range of b\n */","meta":{"filename":"4ub1xeo3td08fep21ado1i.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Determines if one numerical value (a) is within a designated range (diff) of another (b)","kind":"module","name":"within","params":[{"type":{"names":["number"]},"name":"a"},{"type":{"names":["number"]},"name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"name":"diff"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true if a is within the diff range of b"}],"longname":"module:within","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/within.ts","extension":".ts","srcPath":"packages/ui-utils/src/within.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/within","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/within.ts').default","esPath":"@instructure/ui-utils/es/within","themePath":"packages/ui-utils/src/within.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","id":"within","title":"within"} \ No newline at end of file diff --git a/docs/xor.json b/docs/xor.json index b58b719c54..25de43aab8 100644 --- a/docs/xor.json +++ b/docs/xor.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that a prop cannot be given if one or more other props are also\n * given.\n *\n * ```js-code\n * import { xor } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n * significantDigits: xor(PropTypes.number, 'decimalPrecision')\n * }\n * ...\n * ```\n *\n * This will throw an error if both the `decimalPrecision` and\n * `significantDigits` props are provided.\n * @module xor\n * @param {function} propType - validates the prop type. Returns null if valid, error otherwise\n * @param {...string} otherPropNames - reject if any of these other props are also given\n * @returns {function} A function that returns Error if any of the other props\n * are also given, null otherwise\n */","meta":{"filename":"2ptx32rn3zbg1lhyrefcet.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that a prop cannot be given if one or more other props are also\ngiven.\n\n```js-code\n import { xor } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n significantDigits: xor(PropTypes.number, 'decimalPrecision')\n }\n ...\n```\n\nThis will throw an error if both the `decimalPrecision` and\n`significantDigits` props are provided.","kind":"module","name":"xor","params":[{"type":{"names":["function"]},"description":"validates the prop type. Returns null if valid, error otherwise","name":"propType"},{"type":{"names":["string"]},"variable":true,"description":"reject if any of these other props are also given","name":"otherPropNames"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if any of the other props\nare also given, null otherwise"}],"longname":"module:xor","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/xor.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/xor.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/xor","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/xor.ts').default","esPath":"@instructure/ui-prop-types/es/xor","themePath":"packages/ui-prop-types/src/xor.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","id":"xor","title":"xor"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that a prop cannot be given if one or more other props are also\n * given.\n *\n * ```js-code\n * import { xor } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n * significantDigits: xor(PropTypes.number, 'decimalPrecision')\n * }\n * ...\n * ```\n *\n * This will throw an error if both the `decimalPrecision` and\n * `significantDigits` props are provided.\n * @module xor\n * @param {function} propType - validates the prop type. Returns null if valid, error otherwise\n * @param {...string} otherPropNames - reject if any of these other props are also given\n * @returns {function} A function that returns Error if any of the other props\n * are also given, null otherwise\n */","meta":{"filename":"pq437i007ssjafypy251y.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that a prop cannot be given if one or more other props are also\ngiven.\n\n```js-code\n import { xor } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n significantDigits: xor(PropTypes.number, 'decimalPrecision')\n }\n ...\n```\n\nThis will throw an error if both the `decimalPrecision` and\n`significantDigits` props are provided.","kind":"module","name":"xor","params":[{"type":{"names":["function"]},"description":"validates the prop type. Returns null if valid, error otherwise","name":"propType"},{"type":{"names":["string"]},"variable":true,"description":"reject if any of these other props are also given","name":"otherPropNames"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if any of the other props\nare also given, null otherwise"}],"longname":"module:xor","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/xor.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/xor.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/xor","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/xor.ts').default","esPath":"@instructure/ui-prop-types/es/xor","themePath":"packages/ui-prop-types/src/xor.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","id":"xor","title":"xor"} \ No newline at end of file diff --git a/5bc0bae3b3a3eb700d23.ttf b/ea9f6d21499be08b3589.ttf similarity index 99% rename from 5bc0bae3b3a3eb700d23.ttf rename to ea9f6d21499be08b3589.ttf index 8c71e585fa..d791875ccb 100644 Binary files a/5bc0bae3b3a3eb700d23.ttf and b/ea9f6d21499be08b3589.ttf differ diff --git a/main.js b/main.js index 35a6d40774..6978f8bfe0 100644 --- a/main.js +++ b/main.js @@ -4746,7 +4746,7 @@ var NumberInput=__webpack_require__(79915),ScreenReaderContent=__webpack_require const styles=componentTheme=>({paginationPageInput:{label:"paginationPageInput",display:"inline-flex",alignItems:"center",margin:`0 ${componentTheme.inputSpacing}`},numberInput:{label:"paginationPageInput__input",width:componentTheme.inputWidth},inputLabel:{label:"paginationPageInput__inputLabel",marginInlineStart:componentTheme.inputSpacing,whiteSpace:"nowrap"}}),theme=theme=>({...{inputSpacing:theme.spacing.xSmall,inputWidth:"4.5rem"}}),PaginationPageInput_props_propTypes={numberOfPages:prop_types_default().number.isRequired,currentPageIndex:prop_types_default().number.isRequired,onChange:prop_types_default().func.isRequired,screenReaderLabel:prop_types_default().func.isRequired,label:prop_types_default().func,disabled:prop_types_default().bool,inputRef:prop_types_default().func} var PaginationPageInput_class,_PaginationPageInput let PaginationPageInput=(0,withStyle._)(styles,theme)(PaginationPageInput_class=(0,testable.$)()((_PaginationPageInput=class extends react.Component{constructor(props){super(props),this.ref=null,this.handleRef=el=>{this.ref=el},this.handleInputRef=el=>{"function"==typeof this.props.inputRef&&this.props.inputRef(el)},this.handleChange=(_event,value)=>{let newValue=value -value.length>0&&isNaN(value.slice(-1))&&(newValue=value.slice(0,-1)),this.setState({number:newValue?Number(newValue):this.MIN,value:newValue})},this.handleDecrement=event=>{this.setNewPage(event,Math.floor(this.currentPage-1))},this.handleIncrement=event=>{this.setNewPage(event,Math.floor(this.currentPage+1))},this.handleBlur=event=>{this.setNewPage(event,Math.round(this.state.number))},this.state=this.initialState}get currentPage(){return this.props.currentPageIndex+1}get initialState(){return{number:this.currentPage,value:`${this.currentPage}`}}get MIN(){return 1}get MAX(){return this.props.numberOfPages}componentDidMount(){var _this$props$makeStyle,_this$props +value.length>0&&isNaN(value.slice(-1))&&(newValue=value.slice(0,-1)),this.setState({number:newValue?Number(newValue):this.MIN,value:newValue})},this.handleDecrement=event=>{this.setNewPage(event,Math.floor(this.currentPage-1))},this.handleIncrement=event=>{this.setNewPage(event,Math.floor(this.currentPage+1))},this.handleBlur=event=>{Math.round(this.state.number)!==this.currentPage&&this.setNewPage(event,Math.round(this.state.number))},this.state=this.initialState}get currentPage(){return this.props.currentPageIndex+1}get initialState(){return{number:this.currentPage,value:`${this.currentPage}`}}get MIN(){return 1}get MAX(){return this.props.numberOfPages}componentDidMount(){var _this$props$makeStyle,_this$props null===(_this$props$makeStyle=(_this$props=this.props).makeStyles)||void 0===_this$props$makeStyle||_this$props$makeStyle.call(_this$props)}componentDidUpdate(prevProps){var _this$props$makeStyle2,_this$props2 null===(_this$props$makeStyle2=(_this$props2=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props2),this.props.currentPageIndex!==prevProps.currentPageIndex&&this.resetInitialState()}resetInitialState(){this.setState(this.initialState)}handleKeyDown(event){if("enter"===event.key.toLowerCase()){const _this$state=this.state,value=_this$state.value,number=_this$state.number if(""===value||isNaN(value))return void this.resetInitialState() @@ -6418,12 +6418,12 @@ for(;0{"use strict" module.exports=__webpack_require__.p+"d05f4d6060f49b5c7b97.jpg"},38172:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" module.exports=__webpack_require__.p+"28b1b00c4cc6321cd85d.jpg"},94736:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"0859d4840ac51c9600f0.eot"},99306:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"5bc0bae3b3a3eb700d23.ttf"},17114:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"42426daba56305d26181.woff"},37134:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"2b6948f186d1687cd1ea.eot"},2744:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"48b536edb7a1de645e2b.ttf"},86712:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"5dd80f21c02f6b8a854d.woff"},93822:module=>{"use strict" +module.exports=__webpack_require__.p+"4122c5f28d2e47944553.eot"},99306:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"ea9f6d21499be08b3589.ttf"},17114:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"b14a3f72732fc553f31d.woff"},37134:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"dd0f27ff902c97b9344a.eot"},2744:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"bc5b657ab6f18836a036.ttf"},86712:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"4bcd5a36c7a107e6da2a.woff"},93822:module=>{"use strict" module.exports='\n \n\n'},24321:module=>{"use strict" module.exports="FPO: {{w}} x {{h}}\n"},12679:module=>{"use strict" module.exports='\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n'},51665:module=>{"use strict"