diff --git a/pr-preview/pr-1837/docs/Children.json b/pr-preview/pr-1837/docs/Children.json index 63e2c33382..784b6348fb 100644 --- a/pr-preview/pr-1837/docs/Children.json +++ b/pr-preview/pr-1837/docs/Children.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * @module Children\n */","meta":{"filename":"bglfakbazpvg14p2e3mjea.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":"ci24wtzr1wiy5aht5m2k.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/pr-preview/pr-1837/docs/DateTime.json b/pr-preview/pr-1837/docs/DateTime.json index bca36066fc..bdba1e29e3 100644 --- a/pr-preview/pr-1837/docs/DateTime.json +++ b/pr-preview/pr-1837/docs/DateTime.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * @deprecated\n * #### DEPRECATION WARNING: Will be removed in a future version, which will include a\n * time library agnostic API.\n * A wrapper for [moment](https://momentjs.com/) utils.\n * @module DateTime\n */","meta":{"filename":"7sg8mzc7ynkexrykb4lqf.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","deprecated":"#### DEPRECATION WARNING: Will be removed in a future version, which will 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 a future version, which will include a\n * time library agnostic API.\n * A wrapper for [moment](https://momentjs.com/) utils.\n * @module DateTime\n */","meta":{"filename":"26phpmq79dnid9i1tl7eys.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","deprecated":"#### DEPRECATION WARNING: Will be removed in a future version, which will 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/pr-preview/pr-1837/docs/FocusRegion.json b/pr-preview/pr-1837/docs/FocusRegion.json index e04a3a1384..27aa702055 100644 --- a/pr-preview/pr-1837/docs/FocusRegion.json +++ b/pr-preview/pr-1837/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":"dbsmmjd1uvxq05mfbhlgj.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":"whztur5l2qelle4nq9f9p.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/pr-preview/pr-1837/docs/FocusRegionManager.json b/pr-preview/pr-1837/docs/FocusRegionManager.json index 9df2f4836d..6d826980b5 100644 --- a/pr-preview/pr-1837/docs/FocusRegionManager.json +++ b/pr-preview/pr-1837/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":"lnws91kegjjdiysi1v9oc.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":"36hi11hjwa4t6q356okwr.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/pr-preview/pr-1837/docs/FormPropTypes.json b/pr-preview/pr-1837/docs/FormPropTypes.json index b37957622b..5d214b0937 100644 --- a/pr-preview/pr-1837/docs/FormPropTypes.json +++ b/pr-preview/pr-1837/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":"46k5n35fs2ajgk7jucn00c.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":"v3pov2jti6roizazwv92we.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/pr-preview/pr-1837/docs/I18nPropTypes.json b/pr-preview/pr-1837/docs/I18nPropTypes.json index bd7eb35a6a..cac40c971b 100644 --- a/pr-preview/pr-1837/docs/I18nPropTypes.json +++ b/pr-preview/pr-1837/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":"57vuxi9m2m51qwmlrhnmqe.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":"vdoqcyb1j6tl9z9as0yh.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/pr-preview/pr-1837/docs/KeyboardFocusRegion.json b/pr-preview/pr-1837/docs/KeyboardFocusRegion.json index 575f85b6f5..4f54537a83 100644 --- a/pr-preview/pr-1837/docs/KeyboardFocusRegion.json +++ b/pr-preview/pr-1837/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":"8l8c86mzg73ct5cxf6aq2u.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":"gv4pqvk84f6hgy6buk662b.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/pr-preview/pr-1837/docs/Locale.json b/pr-preview/pr-1837/docs/Locale.json index 89b1b6570b..ac63b71f3f 100644 --- a/pr-preview/pr-1837/docs/Locale.json +++ b/pr-preview/pr-1837/docs/Locale.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * Localization utilities\n * @module Locale\n */","meta":{"filename":"yhamep6ix4ck4yfe389c8.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":"ba2t1r68sih9cxwo1xb9zs.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/pr-preview/pr-1837/docs/MenuContext.json b/pr-preview/pr-1837/docs/MenuContext.json index 34f8bfcddc..2b19c9cbb5 100644 --- a/pr-preview/pr-1837/docs/MenuContext.json +++ b/pr-preview/pr-1837/docs/MenuContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module MenuContext\n**/","meta":{"filename":"ovfyxzysm8q9fsklv5l3.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":"zfkg948ub4fwt6q04yf1h.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/pr-preview/pr-1837/docs/PositionPropTypes.json b/pr-preview/pr-1837/docs/PositionPropTypes.json index 5a9fc4b9aa..ef00de9c2d 100644 --- a/pr-preview/pr-1837/docs/PositionPropTypes.json +++ b/pr-preview/pr-1837/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":"mxir7woy0ub41gitq5t8fx.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":"wssulvb5d2cpru7kvv83g.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/pr-preview/pr-1837/docs/ResponsivePropTypes.json b/pr-preview/pr-1837/docs/ResponsivePropTypes.json index 594b16016f..13ca6f4ad4 100644 --- a/pr-preview/pr-1837/docs/ResponsivePropTypes.json +++ b/pr-preview/pr-1837/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":"7o4bsnfvfn9yxwkd8vq2b.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":"7ks0vvzt3mgydabsybltf.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/pr-preview/pr-1837/docs/ScreenReaderFocusRegion.json b/pr-preview/pr-1837/docs/ScreenReaderFocusRegion.json index 2fe72ac283..473d029495 100644 --- a/pr-preview/pr-1837/docs/ScreenReaderFocusRegion.json +++ b/pr-preview/pr-1837/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":"u43sekxulms4mvl9jwzam.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":"40s2uhyjiisikzj206wss.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/pr-preview/pr-1837/docs/TextDirectionContext.json b/pr-preview/pr-1837/docs/TextDirectionContext.json index 0ccecadeba..a59269c789 100644 --- a/pr-preview/pr-1837/docs/TextDirectionContext.json +++ b/pr-preview/pr-1837/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":"a4crdd5b0zakm2c7g6ffb.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":"iv58uc40plkpc2nhphszup.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/pr-preview/pr-1837/docs/ThemeRegistry.json b/pr-preview/pr-1837/docs/ThemeRegistry.json index 4e7897eb10..ceecd7ffe4 100644 --- a/pr-preview/pr-1837/docs/ThemeRegistry.json +++ b/pr-preview/pr-1837/docs/ThemeRegistry.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * DEPRECATED. This will be deleted, please use InstUISettingsProvider instead.\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":"xyierq40pmftzcxliqdzc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"DEPRECATED. This will be deleted, please use InstUISettingsProvider instead.\nA 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 * DEPRECATED. This will be deleted, please use InstUISettingsProvider instead.\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":"7egrpco6xmvtsxk3qn2qg.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"DEPRECATED. This will be deleted, please use InstUISettingsProvider instead.\nA 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/pr-preview/pr-1837/docs/ThemeablePropTypes.json b/pr-preview/pr-1837/docs/ThemeablePropTypes.json index 41b0979dd4..d97aa4709c 100644 --- a/pr-preview/pr-1837/docs/ThemeablePropTypes.json +++ b/pr-preview/pr-1837/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":"8aeh7xt8me2sq4lh14ijok.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":"ltkoy4i2dw82wm109ctgb.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/pr-preview/pr-1837/docs/TopNavBarContext.json b/pr-preview/pr-1837/docs/TopNavBarContext.json index fd6e5f574b..b928ed2203 100644 --- a/pr-preview/pr-1837/docs/TopNavBarContext.json +++ b/pr-preview/pr-1837/docs/TopNavBarContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module TopNavBarContext\n**/","meta":{"filename":"yzhnxx5co9awx6rmusei9.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":"uf5ioel4mbsakqf7frdbof.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/pr-preview/pr-1837/docs/addElementQueryMatchListener.json b/pr-preview/pr-1837/docs/addElementQueryMatchListener.json index 68391cabe5..177bb6b5a9 100644 --- a/pr-preview/pr-1837/docs/addElementQueryMatchListener.json +++ b/pr-preview/pr-1837/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":"gwby0syb6qrh9efgaxka.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":"cmzcvjxzpam2cp0u8yp3hd.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/pr-preview/pr-1837/docs/addEventListener.json b/pr-preview/pr-1837/docs/addEventListener.json index ebb3974059..f9136d01c0 100644 --- a/pr-preview/pr-1837/docs/addEventListener.json +++ b/pr-preview/pr-1837/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":"7icsozkuexwwxqkupve3aq.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":"cpxtyzey7lroyxqfwvfgze.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/pr-preview/pr-1837/docs/addMediaQueryMatchListener.json b/pr-preview/pr-1837/docs/addMediaQueryMatchListener.json index 9bba2df8af..4872ebb657 100644 --- a/pr-preview/pr-1837/docs/addMediaQueryMatchListener.json +++ b/pr-preview/pr-1837/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":"slcjprcr68k2j11n5ato.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":"ww9rlwiamknm3iop408ss.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/pr-preview/pr-1837/docs/addPositionChangeListener.json b/pr-preview/pr-1837/docs/addPositionChangeListener.json index 801c96e1d1..ce81069b79 100644 --- a/pr-preview/pr-1837/docs/addPositionChangeListener.json +++ b/pr-preview/pr-1837/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":"z7ll0p0q6yhb9ws6soac16.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":"z7ll0p0q6yhb9ws6soac16","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:z7ll0p0q6yhb9ws6soac16","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":"az05sgyd666fspog6lx19.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":"az05sgyd666fspog6lx19","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:az05sgyd666fspog6lx19","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/pr-preview/pr-1837/docs/alpha.json b/pr-preview/pr-1837/docs/alpha.json index a62dde6a44..fc8727af46 100644 --- a/pr-preview/pr-1837/docs/alpha.json +++ b/pr-preview/pr-1837/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":"8tb41dp8t33i5vg0ce2igd.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":"fncy7sfsmxh8f0wgslyfvy.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/pr-preview/pr-1837/docs/calculateElementPosition.json b/pr-preview/pr-1837/docs/calculateElementPosition.json index 76f9821839..7a78c4e342 100644 --- a/pr-preview/pr-1837/docs/calculateElementPosition.json +++ b/pr-preview/pr-1837/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":"m4n1p5sq1b5tkgnw7wogf.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":"m4n1p5sq1b5tkgnw7wogf","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:m4n1p5sq1b5tkgnw7wogf","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":"0yrf5jkxcru4jtmd17y71g.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":"0yrf5jkxcru4jtmd17y71g","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:0yrf5jkxcru4jtmd17y71g","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/pr-preview/pr-1837/docs/callRenderProp.json b/pr-preview/pr-1837/docs/callRenderProp.json index 27954cb232..358ee79cb3 100644 --- a/pr-preview/pr-1837/docs/callRenderProp.json +++ b/pr-preview/pr-1837/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":"6ssrtn5pcj9u7qd2y7hcck.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":"95vunwbq7plomvkumfljbm.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/pr-preview/pr-1837/docs/camelize.json b/pr-preview/pr-1837/docs/camelize.json index aa6e726b6c..ea2b90b08c 100644 --- a/pr-preview/pr-1837/docs/camelize.json +++ b/pr-preview/pr-1837/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":"caoo0l1uviuf0a36289u3v.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":"an4rbczbs8d1ei468za3z3.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/pr-preview/pr-1837/docs/canUseDOM.json b/pr-preview/pr-1837/docs/canUseDOM.json index 1122a1ab42..79b875b422 100644 --- a/pr-preview/pr-1837/docs/canUseDOM.json +++ b/pr-preview/pr-1837/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":"yiuv70gpdw2w5ldvf52rh.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"yiuv70gpdw2w5ldvf52rh","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:yiuv70gpdw2w5ldvf52rh","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":"qnyaw5qg9x5brnp03jna4.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"qnyaw5qg9x5brnp03jna4","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:qnyaw5qg9x5brnp03jna4","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/pr-preview/pr-1837/docs/capitalizeFirstLetter.json b/pr-preview/pr-1837/docs/capitalizeFirstLetter.json index b6f5a24539..d68c25f1d1 100644 --- a/pr-preview/pr-1837/docs/capitalizeFirstLetter.json +++ b/pr-preview/pr-1837/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":"6hh7aoj5bk4p1057qgni5o.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":"u6iowu9dz1534dvcedpet.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/pr-preview/pr-1837/docs/childrenOrValue.json b/pr-preview/pr-1837/docs/childrenOrValue.json index b01a3a51df..497eae89f4 100644 --- a/pr-preview/pr-1837/docs/childrenOrValue.json +++ b/pr-preview/pr-1837/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":"jv235nl6w67l0atlzclig.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":"os9zcpjsa8c6fzk7pph2q.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/pr-preview/pr-1837/docs/cloneArray.json b/pr-preview/pr-1837/docs/cloneArray.json index cc8e88c11a..482dfa2140 100644 --- a/pr-preview/pr-1837/docs/cloneArray.json +++ b/pr-preview/pr-1837/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":"ulppgmix6v8z56k9ljapn.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":"a8vkxzgxt2cipa5c46k92.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/pr-preview/pr-1837/docs/contains.json b/pr-preview/pr-1837/docs/contains.json index 258eb8350b..6130dd6cf1 100644 --- a/pr-preview/pr-1837/docs/contains.json +++ b/pr-preview/pr-1837/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":"74k2zeefu2uv431gemvd7.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":"snayjvymidzqcvinni2w.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/pr-preview/pr-1837/docs/containsActiveElement.json b/pr-preview/pr-1837/docs/containsActiveElement.json index 8df1b8b85b..3212d2417c 100644 --- a/pr-preview/pr-1837/docs/containsActiveElement.json +++ b/pr-preview/pr-1837/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":"bm5okx9m7f0u6if9ryy24k.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":"hgl5ojt5imhha51cv2xao.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/pr-preview/pr-1837/docs/contrast.json b/pr-preview/pr-1837/docs/contrast.json index 7a51d5faef..b0e034ea97 100644 --- a/pr-preview/pr-1837/docs/contrast.json +++ b/pr-preview/pr-1837/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":"62l2qheyi1yjybkljbmrd.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":"jaopzu3dbzf9kbu5olxju.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/pr-preview/pr-1837/docs/contrastWithAlpha.json b/pr-preview/pr-1837/docs/contrastWithAlpha.json index 4404421c06..44c280921a 100644 --- a/pr-preview/pr-1837/docs/contrastWithAlpha.json +++ b/pr-preview/pr-1837/docs/contrastWithAlpha.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Calculates two, not necesseraly opaque color's contrast on top of each other.\n * The method assumes that the bottom color is on top of a white background (only important if it isn't opaque)\n * @module contrastWithAlpha\n * @param {String} color1\n * @param {String} color2\n * @param {Number} decimalPlaces\n * @returns {Number} color contrast ratio\n */","meta":{"filename":"97fu985azgm8i9q2l7ien3.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Calculates two, not necesseraly opaque color's contrast on top of each other.\nThe method assumes that the bottom color is on top of a white background (only important if it isn't opaque)","kind":"module","name":"contrastWithAlpha","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:contrastWithAlpha","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/contrastWithAlpha.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/contrastWithAlpha.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrastWithAlpha.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/contrastWithAlpha","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/contrastWithAlpha.ts').default","esPath":"@instructure/ui-color-utils/es/contrastWithAlpha","themePath":"packages/ui-color-utils/src/contrastWithAlpha.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrastWithAlpha.ts","id":"contrastWithAlpha","title":"contrastWithAlpha"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Calculates two, not necesseraly opaque color's contrast on top of each other.\n * The method assumes that the bottom color is on top of a white background (only important if it isn't opaque)\n * @module contrastWithAlpha\n * @param {String} color1\n * @param {String} color2\n * @param {Number} decimalPlaces\n * @returns {Number} color contrast ratio\n */","meta":{"filename":"1o16c5oyqea1dzoykl1fn.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Calculates two, not necesseraly opaque color's contrast on top of each other.\nThe method assumes that the bottom color is on top of a white background (only important if it isn't opaque)","kind":"module","name":"contrastWithAlpha","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:contrastWithAlpha","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/contrastWithAlpha.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/contrastWithAlpha.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrastWithAlpha.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/contrastWithAlpha","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/contrastWithAlpha.ts').default","esPath":"@instructure/ui-color-utils/es/contrastWithAlpha","themePath":"packages/ui-color-utils/src/contrastWithAlpha.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/contrastWithAlpha.ts","id":"contrastWithAlpha","title":"contrastWithAlpha"} \ No newline at end of file diff --git a/pr-preview/pr-1837/docs/controllable.json b/pr-preview/pr-1837/docs/controllable.json index 24e9b93c5b..52514022d5 100644 --- a/pr-preview/pr-1837/docs/controllable.json +++ b/pr-preview/pr-1837/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":"6x9egjzu1hjtrbe53x3enm.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":"m6l50i4t4fz63xqvg9gt.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/pr-preview/pr-1837/docs/conversions.json b/pr-preview/pr-1837/docs/conversions.json index d736023b88..5a1e34a7b3 100644 --- a/pr-preview/pr-1837/docs/conversions.json +++ b/pr-preview/pr-1837/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":"y2y2z3gbgvkgccm5jgfn5v.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":"9oao64f6btatgup4ueeeb.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/pr-preview/pr-1837/docs/createChainedFunction.json b/pr-preview/pr-1837/docs/createChainedFunction.json index 37a928a6ce..bcb144663d 100644 --- a/pr-preview/pr-1837/docs/createChainedFunction.json +++ b/pr-preview/pr-1837/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":"h5d5igkz8sm2k8h4367u2y.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":"qg3psv01yzcyysjxr99le.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/pr-preview/pr-1837/docs/cursor.json b/pr-preview/pr-1837/docs/cursor.json index 644a605dc0..a496dfeb7f 100644 --- a/pr-preview/pr-1837/docs/cursor.json +++ b/pr-preview/pr-1837/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":"yckure6dl6bsbynp0m68i9.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":"5qdd4cgfn2kchwpcnwws7d.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/pr-preview/pr-1837/docs/darken.json b/pr-preview/pr-1837/docs/darken.json index 03151604e3..72fbbcafaf 100644 --- a/pr-preview/pr-1837/docs/darken.json +++ b/pr-preview/pr-1837/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":"oun8kkr358go2adsuictc.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":"j0lq0ks4lbfoa303ibcyr.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/pr-preview/pr-1837/docs/debounce.json b/pr-preview/pr-1837/docs/debounce.json index 3e0fc23962..5f92b98072 100644 --- a/pr-preview/pr-1837/docs/debounce.json +++ b/pr-preview/pr-1837/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 * For a cool explanation see https://css-tricks.com/debouncing-throttling-explained-examples/\n *\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":"1y15bhghi9ssgucbohaj4a.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.\nFor a cool explanation see https://css-tricks.com/debouncing-throttling-explained-examples/","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 * For a cool explanation see https://css-tricks.com/debouncing-throttling-explained-examples/\n *\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":"e7jfyf2m54nldy9ul2tuv.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.\nFor a cool explanation see https://css-tricks.com/debouncing-throttling-explained-examples/","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/pr-preview/pr-1837/docs/decorator.json b/pr-preview/pr-1837/docs/decorator.json index 799c5386b2..974399a5c3 100644 --- a/pr-preview/pr-1837/docs/decorator.json +++ b/pr-preview/pr-1837/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":"953ijwkfwzpzs1q35qyrg.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":"g2ddlgcak7uggshj1nz8p.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/pr-preview/pr-1837/docs/deepEqual.json b/pr-preview/pr-1837/docs/deepEqual.json index 1258d454e8..896870ebe5 100644 --- a/pr-preview/pr-1837/docs/deepEqual.json +++ b/pr-preview/pr-1837/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":"grc3qi709p6p2xgc0scok.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":"kssnfcvs56c62xteppav6v.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/pr-preview/pr-1837/docs/deprecated.json b/pr-preview/pr-1837/docs/deprecated.json index 7557cc39fc..282636b465 100644 --- a/pr-preview/pr-1837/docs/deprecated.json +++ b/pr-preview/pr-1837/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":"dxq9hvqudxd563jc6kj6mn.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":"35yak87t89o3tb9n39meqv.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/pr-preview/pr-1837/docs/element.json b/pr-preview/pr-1837/docs/element.json index 72dbf37faa..98b08fb12a 100644 --- a/pr-preview/pr-1837/docs/element.json +++ b/pr-preview/pr-1837/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":"oj0o1qqahcm8kwn0ac5xk3.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":"kraoit7mq6dcbknb1c4q4.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/pr-preview/pr-1837/docs/ensureSingleChild.json b/pr-preview/pr-1837/docs/ensureSingleChild.json index 526d234e2e..9012c7d43f 100644 --- a/pr-preview/pr-1837/docs/ensureSingleChild.json +++ b/pr-preview/pr-1837/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":"23rblgnds77lvayrijpd5.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":"qp5phnnd0ijlr0910ejeq.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/pr-preview/pr-1837/docs/experimental.json b/pr-preview/pr-1837/docs/experimental.json index 49d31cb3d8..1903d59b28 100644 --- a/pr-preview/pr-1837/docs/experimental.json +++ b/pr-preview/pr-1837/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":"smzgakt5i5jr81soi2ry1.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":"zgpwdibjtist2r5m5qr98q.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/pr-preview/pr-1837/docs/findDOMNode.json b/pr-preview/pr-1837/docs/findDOMNode.json index ba73be65d4..4212007c0f 100644 --- a/pr-preview/pr-1837/docs/findDOMNode.json +++ b/pr-preview/pr-1837/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":"0hre87l4jrzp1o2rfcrp2mw.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":"o07mdjmcmkj19pc6jcxo8.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/pr-preview/pr-1837/docs/findFocusable.json b/pr-preview/pr-1837/docs/findFocusable.json index 1358ad1cbf..71ecd8119f 100644 --- a/pr-preview/pr-1837/docs/findFocusable.json +++ b/pr-preview/pr-1837/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":"0a58mz1d2aiqy12db2bwffk.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":"ez1xpheg5z6swcatzhgf7.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/pr-preview/pr-1837/docs/findTabbable.json b/pr-preview/pr-1837/docs/findTabbable.json index e3a180d7af..cd7246b148 100644 --- a/pr-preview/pr-1837/docs/findTabbable.json +++ b/pr-preview/pr-1837/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":"waeabqhma84sf0vbaigze.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":"q364mvtf5slwrlszils1k.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/pr-preview/pr-1837/docs/getActiveElement.json b/pr-preview/pr-1837/docs/getActiveElement.json index 86133a69a4..4953d13511 100644 --- a/pr-preview/pr-1837/docs/getActiveElement.json +++ b/pr-preview/pr-1837/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":"4ctwtaypn2yvqmxzxswka9.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":"72g97s80j2u6qa0xpnivq3.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/pr-preview/pr-1837/docs/getBoundingClientRect.json b/pr-preview/pr-1837/docs/getBoundingClientRect.json index 35cb869aa5..2b4d354f41 100644 --- a/pr-preview/pr-1837/docs/getBoundingClientRect.json +++ b/pr-preview/pr-1837/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":"mhi3qyjqhbcj58822atxe.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":"pohu3exd65finckcpuf8a.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/pr-preview/pr-1837/docs/getBrowser.json b/pr-preview/pr-1837/docs/getBrowser.json index f6b07cffa5..9bd74d3619 100644 --- a/pr-preview/pr-1837/docs/getBrowser.json +++ b/pr-preview/pr-1837/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":"urjgxxqensqznmsd0ydk.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":"mqmv40ya2413uww9p27hdo.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/pr-preview/pr-1837/docs/getClassList.json b/pr-preview/pr-1837/docs/getClassList.json index 620e31626e..715a78cc1c 100644 --- a/pr-preview/pr-1837/docs/getClassList.json +++ b/pr-preview/pr-1837/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":"k48wrt71s651f4eyu95z9.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":"nthuchuucucly58nene8c.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/pr-preview/pr-1837/docs/getComputedStyle.json b/pr-preview/pr-1837/docs/getComputedStyle.json index 1a31c64416..0519ff5f09 100644 --- a/pr-preview/pr-1837/docs/getComputedStyle.json +++ b/pr-preview/pr-1837/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":"bz47658jx7se5622vtvuzb.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":"5c3ukougt8kod2nt2gohsg.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/pr-preview/pr-1837/docs/getDisplayName.json b/pr-preview/pr-1837/docs/getDisplayName.json index 2c9428e959..1bbb8da14b 100644 --- a/pr-preview/pr-1837/docs/getDisplayName.json +++ b/pr-preview/pr-1837/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":"1olls5x0hp2il89ajidqlr.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":"svydqc0rq0i3tkuit35lh.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/pr-preview/pr-1837/docs/getElementType.json b/pr-preview/pr-1837/docs/getElementType.json index 5143dc5fe2..3c4d0ce42a 100644 --- a/pr-preview/pr-1837/docs/getElementType.json +++ b/pr-preview/pr-1837/docs/getElementType.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the React element type for a component. It uses the following logic:\n * 1. type defined by the `as` prop\n * 2. type returned by the `getDefault()` parameter\n * 3. `` if it has a `href` or `to` prop\n * 4. `