diff --git a/pr-preview/pr-1812/docs/Children.json b/pr-preview/pr-1812/docs/Children.json index 851b027b6b..7867400fa3 100644 --- a/pr-preview/pr-1812/docs/Children.json +++ b/pr-preview/pr-1812/docs/Children.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * @module Children\n */","meta":{"filename":"6760pci684aaea2aogangj.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":"kzwyrlipxr9t9e8jg3rwo.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-1812/docs/DateTime.json b/pr-preview/pr-1812/docs/DateTime.json index 385d24b10e..9774173791 100644 --- a/pr-preview/pr-1812/docs/DateTime.json +++ b/pr-preview/pr-1812/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":"y867lmd09vpbe1px72r50d.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":"43ulf6vr7nqcegigbkqo3f.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-1812/docs/FocusRegion.json b/pr-preview/pr-1812/docs/FocusRegion.json index 59f783e4dd..733ed3db0f 100644 --- a/pr-preview/pr-1812/docs/FocusRegion.json +++ b/pr-preview/pr-1812/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":"ppsa91870vbmrtsbcihpr.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":"nfbl2rixbdjej541a0l4oe.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-1812/docs/FocusRegionManager.json b/pr-preview/pr-1812/docs/FocusRegionManager.json index 62ffb62444..03979ff6b1 100644 --- a/pr-preview/pr-1812/docs/FocusRegionManager.json +++ b/pr-preview/pr-1812/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":"9w00avvl1kzxbl2hrd29m.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":"6x5wljj2fciktjlkymupu.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-1812/docs/FormPropTypes.json b/pr-preview/pr-1812/docs/FormPropTypes.json index ca1335315b..7adac96eb8 100644 --- a/pr-preview/pr-1812/docs/FormPropTypes.json +++ b/pr-preview/pr-1812/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":"g5rnufbtsyhisp12s2xfy.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":"fcalckty6huhpe1sqbhyp.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-1812/docs/I18nPropTypes.json b/pr-preview/pr-1812/docs/I18nPropTypes.json index 6006eaf249..ca57ef57d4 100644 --- a/pr-preview/pr-1812/docs/I18nPropTypes.json +++ b/pr-preview/pr-1812/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":"kb82ahozrnmxu8o6aowir.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":"7lg67531tzytiqxlkd0ynq.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-1812/docs/KeyboardFocusRegion.json b/pr-preview/pr-1812/docs/KeyboardFocusRegion.json index b57ddab386..e39daa3851 100644 --- a/pr-preview/pr-1812/docs/KeyboardFocusRegion.json +++ b/pr-preview/pr-1812/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":"2d6ntx1qxm3dpzo0y1f39.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":"qea45fnddcncczrswy4ryj.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-1812/docs/Locale.json b/pr-preview/pr-1812/docs/Locale.json index 400f90b6b2..813e48f00a 100644 --- a/pr-preview/pr-1812/docs/Locale.json +++ b/pr-preview/pr-1812/docs/Locale.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * Localization utilities\n * @module Locale\n */","meta":{"filename":"p5chqh8rcafui4fofk91h.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":"ep177qsoh2f3dw8w2rqtn.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-1812/docs/MenuContext.json b/pr-preview/pr-1812/docs/MenuContext.json index f166498fe9..c5aad24c52 100644 --- a/pr-preview/pr-1812/docs/MenuContext.json +++ b/pr-preview/pr-1812/docs/MenuContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module MenuContext\n**/","meta":{"filename":"5rhtmo0l07xejlba6e1i3u.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":"xtnvzb425izygp88ixft9.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-1812/docs/PositionPropTypes.json b/pr-preview/pr-1812/docs/PositionPropTypes.json index fb0bf334f7..e4c6e973b2 100644 --- a/pr-preview/pr-1812/docs/PositionPropTypes.json +++ b/pr-preview/pr-1812/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":"sbalfq0ss4312qsb8ib5h.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":"t9prf4ouutghsk1dsjsddc.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-1812/docs/ResponsivePropTypes.json b/pr-preview/pr-1812/docs/ResponsivePropTypes.json index 298ab9c85a..12a37f4806 100644 --- a/pr-preview/pr-1812/docs/ResponsivePropTypes.json +++ b/pr-preview/pr-1812/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":"2lzu3l2nbo9fpt5zyvjimn.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":"mfvmedueh0g53v6fo4yqq.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-1812/docs/ScreenReaderFocusRegion.json b/pr-preview/pr-1812/docs/ScreenReaderFocusRegion.json index 9de7b60eab..1067e17577 100644 --- a/pr-preview/pr-1812/docs/ScreenReaderFocusRegion.json +++ b/pr-preview/pr-1812/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":"a0jb1r39n1vse8jrjoet.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":"f9qngz9ioxszssccw53v7.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-1812/docs/SourceCodeEditor.json b/pr-preview/pr-1812/docs/SourceCodeEditor.json index b1aac3daca..c05476dc8c 100644 --- a/pr-preview/pr-1812/docs/SourceCodeEditor.json +++ b/pr-preview/pr-1812/docs/SourceCodeEditor.json @@ -1 +1 @@ -{"description":"\nA wrapper around the popular [CodeMirror](https://codemirror.net/) code editor component. CodeMirror provides a text input field with features like line gutters, syntax highlighting, and autocompletion.\n\n```javascript\n---\ntype: embed\n---\n\n \n If you are currently using our CodeEditor component, we suggest upgrading to SourceCodeEditor, because it has many more features and is way more accessible.\n \n \n See the migration guide at the bottom of the CodeEditor docs page for more info.\n \n\n```\n\n### Built-in features\n\nSourceCodeEditor has a lot of built-in features that makes editing code easier.\n\n##### Command keybinding\n\nThe editor has a lot of handy key bindings for commands like copying and deleting lines, moving lines up and down, selection and indentation, etc. See the keymaps here: [defaultKeymap](https://codemirror.net/docs/ref/#commands.defaultKeymap), [closeBracketsKeymap](https://codemirror.net/docs/ref/#autocomplete.closeBracketsKeymap), [historyKeymap](https://codemirror.net/docs/ref/#commands.historyKeymap), [foldKeymap](https://codemirror.net/docs/ref/#language.foldKeymap), [completionKeymap](https://codemirror.net/docs/ref/#autocomplete.completionKeymap), [lintKeymap](https://codemirror.net/docs/ref/#lint.lintKeymap).\n\n##### History\n\nThe history feature remembers the steps of the code editing and selections, and lets you undo and redo them.\n\n##### Cursor and selection\n\nInstead of using the browser's native selection and cursor, SourceCodeEditor uses its own system. This allows the editor to display secondary selection ranges, and tends to produce a type of selection more in line with that users expect in a text editor.\n\nIt also allows **multiple** cursors to be placed (`Cmd/Ctrl` + click), multiple ranges to be selected and edited at the same time.\n\n**Rectangular selections:** by default, it will react to left mouse drag with the `Option/Alt` key held down. When such a selection occurs, the text within the rectangle that was dragged over will be selected, as one selection range per line.\n\nThe editor highlights text that matches the current selection.\n\n##### Bracket matching and closing\n\nWhenever the cursor is next to a bracket, that bracket and the one it matches are highlighted. Or, when no matching bracket is found, another highlighting style is used to indicate this.\n\nWhen a closeable bracket is typed, its closing bracket is immediately inserted after the cursor.\n\n### Language support\n\nSetting the correct language adds **syntax highlighting** and other helpful features to the editor, like **code folding**, **auto-indentation**, **syntax-aware selection** and **autocompletion** features.\n\n**Note:** In case you need support for additional languages, please contact us on [GitHub](https://github.com/instructure/instructure-ui)!\n\n```js\n---\ntype: example\n---\n\nconst languages = {\n json: `{\n \"name\": \"@instructure/ui-source-code-editor\",\n \"version\": \"8.24.2\",\n \"description\": \"A UI component library made by Instructure Inc.\",\n \"author\": \"Instructure, Inc. Engineering and Product Design\",\n \"module\": \"./es/index.js\",\n \"main\": \"./lib/index.js\",\n \"types\": \"./types/index.d.ts\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/instructure/instructure-ui.git\"\n },\n}`,\n javascript: `const fruit: string = \"apple\"\n\nconst re = new RegExp('ab+c')\n\nfunction exampleMethod(props: Props) {\n return props ? props.value : null\n}\n\n/**\n * This is an example\n * @param {Object} props\n */\nconst Example = () => {\n return (\n \n }\n placement='end center'\n offsetX='20px'\n >\n \n Positioned content\n \n \n \n )\n}\n\nrender()`,\n html: `\n\n \n \n \n \n Example app\n \n \n
\n \n
\n\n \n \n`,\n css: `a {\n text-decoration: none;\n\n &:hover { text-decoration: underline; }\n}\n\na:link, a:visited, a:hover, a:active {\n background-color: green;\n color: white;\n padding: 10px 25px;\n text-align: center;\n text-decoration: none;\n display: inline-block;\n}\n\n.centertext { text-align: center; }\n\nimg { opacity: 0.5; filter: alpha(opacity=50); }`,\n markdown: `#### The quarterly results look great!\n\n> - Revenue was off the chart.\n> - Profits were higher than ever.\n\n*Everything* is going according to **plan**.\n\n---\ntype: example\n---`,\n shell: `#!/bin/bash\n\n# example of using arguments to a script\necho \"My first name is $1\"\necho \"My surname is $2\"\necho \"Total number of arguments is $#\"\n\n________________________________________\n\n$ chmod a+x name.sh\n$ ./name.sh Hans-Wolfgang Loidl\nMy first name is Hans-Wolfgang\nMy surname is Loidl\nTotal number of arguments is 2`,\n yml: `---\n doe: \"a deer, a female deer\"\n ray: \"a drop of golden sun\"\n pi: 3.14159\n xmas: true\n french-hens: 3\n calling-birds:\n - huey\n - dewey\n - louie\n - fred\n xmas-fifth-day:\n calling-birds: four\n french-hens: 3\n golden-rings: 5\n partridges:\n count: 1\n location: \"a pear tree\"\n turtle-doves: two`\n}\n\nconst languageMap = {\n json: languages.json,\n js: languages.javascript,\n jsx: languages.javascript,\n javascript: languages.javascript,\n html: languages.html,\n css: languages.css,\n markdown: languages.markdown,\n sh: languages.shell,\n shell: languages.shell,\n bash: languages.shell,\n yml: languages.yml,\n yaml: languages.yml,\n}\n\nclass LanguageExamples extends React.Component {\n state = {\n currentLanguage: 'javascript',\n currentValue: languageMap.javascript,\n }\n\n render() {\n const languageKeys = Object.keys(languageMap)\n\n return (\n \n \n {\n this.setState({\n currentLanguage,\n currentValue: languageMap[currentLanguage]\n })\n }}\n >\n {languageKeys.map(language => (\n ))}\n \n \n\n \n \n {\n this.setState({\n currentValue: value\n })\n }}\n lineNumbers\n lineWrapping\n highlightActiveLine\n highlightActiveLineGutter\n />\n \n \n \n )\n }\n}\n\nrender()\n\n```\n\n### Controlled mode\n\nSourceCodeEditor works best as an uncontrolled component (with the `defaultValue` prop), and that is how we recommend it to be used. As an uncontrolled component, the underlying CodeMirror component can take care of all interactions.\n\nWe've implemented the \"controlled\" usage, but please let us know if you run into any performance issues or bugs.\n\n```js\n---\ntype: example\n---\nclass ControlledExample extends React.Component {\n state = {\n value: `const fruit: string = \"apple\"\n\nfunction exampleMethod(props: Props) {\n return props ? props.value : null\n}`\n }\n\n textAreaRef = null\n\n render () {\n return (\n \n \n \n \n {\n this.setState({ value })\n }}\n highlightActiveLine\n highlightActiveLineGutter\n lineWrapping\n lineNumbers\n foldGutter\n spellcheck\n />\n \n \n \n \n Change value}\n textareaRef={(e) => { this.textAreaRef = e }}\n defaultValue={this.state.value}\n />\n \n \n \n \n \n )\n }\n}\n\nrender()\n```\n\n### Editable and readOnly\n\nThe editability of the content can be set with the combination of the `editable` and `readOnly` props.\n\nThe `readOnly` prop works like a \"preventDefault\" and disables any interaction by the user or API calls (e.g. copy-paste).\nIf the `editable` prop is set to `false`, the editor is also not focusable, and the `contenteditable=\"false\"` is set on the content.\n\n```js\n---\ntype: example\n---\nclass EditableExample extends React.Component {\n state = {\n editable: true,\n readOnly: false\n }\n\n render () {\n return (\n \n \n \n {['editable', 'readOnly'].map((prop) => (\n {\n this.setState({ [prop]: !this.state[prop] })\n }}\n />\n ))}\n \n \n\n \n \n )\n }\n}\n\nrender()\n```\n\n### Gutter settings\n\nThe `lineNumbers` prop displays the line numbers in the side gutter, and the `foldGutter` prop displays the toggleable fold icon next to foldable code blocks.\n\nIf any of these two props are active, the gutter is displayed, and the `highlightActiveLineGutter` highlights the active line in the gutter. (The `highlightActiveLine` prop highlights the line itself.)\n\n```js\n---\ntype: example\n---\nclass GutterExample extends React.Component {\n state = {\n lineNumbers: true,\n foldGutter: true,\n highlightActiveLineGutter: true,\n highlightActiveLine: true,\n }\n\n render () {\n return (\n \n \n \n {['lineNumbers', 'foldGutter', 'highlightActiveLineGutter', 'highlightActiveLine'].map((prop) => (\n {\n this.setState({ [prop]: !this.state[prop] })\n }}\n />\n ))}\n \n \n\n {\n return (\n \n }\n placement='end center'\n offsetX='20px'\n >\n \n Positioned content\n \n \n \n )\n}\n\nrender()`}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Indentation\n\n##### auto-indent\n\nThe editor automatically indents the lines on input. The `indentOnLoad` prop indents the code on the initial load and when the `value` prop is updated.\n\n##### indent with tab\n\nWhen the `indentWithTab` feature is turned on, Tab and Shift-Tab will indent the code.\nBy default, it is turned off, and tabbing will focus the next element in the tab order.\n\n**Accessibility note**: Even if `indentWithTab` is on, pressing Escape before tabbing will not handle indentation and will handle focus instead. When using this feature, it is recommended to add info about this behaviour in your documentation.\n\n##### indent unit\n\nYou can also override the unit by which indentation happens (defaults to 2 spaces).\nThe `indentUnitCount` prop should be a string consisting either entirely of spaces or entirely of tabs.\n\n##### manual re-indent\n\nAnother useful feature is the `indentAll` public method on the `SourceCodeEditor` component that can be called anytime to trigger a re-indent on the content.\n\n```js\n---\ntype: example\n---\nclass IndentExample extends React.Component {\n state = {\n indentWithTab: true,\n indentUnitCount: '2',\n }\n\n editor = null\n\n get indentUnit() {\n return Array(parseInt(this.state.indentUnitCount)).fill(' ').join('')\n }\n\n reIndent () {\n this.editor.indentAll()\n }\n\n indentCurrentSelection () {\n this.editor.indentCurrentSelection()\n }\n\n render () {\n return (\n \n \n \n {\n this.setState({ indentWithTab: !this.state.indentWithTab })\n }}\n />\n {\n this.setState({indentUnitCount})\n this.reIndent()\n }}\n >\n {['2', '4', '8'].map(count => )}\n \n \n \n \n \n\n { this.editor = component }}\n language=\"jsx\"\n indentWithTab={this.state.indentWithTab}\n indentUnit={this.indentUnit}\n defaultValue={`const fruit: string = \"apple\"\n\nfunction exampleMethod(props: Props) {\n return props ? props.value : null\n}\n\n/**\n * This is an example\n * @param {Object} props\n */\nconst Example = () => {\n return (\n \n }\n placement='end center'\n offsetX='20px'\n >\n \n Positioned content\n \n \n \n )\n}\n\nrender()`}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Direction\n\nSourceCodeEditor is a bidirectional component. It will inherit the text-direction from the context, and can be set directly on the component with the `direction` prop. The `rtl` mode will flip the overall layout and selects base paragraph direction to RTL.\n\nThe `rtlMoveVisually` prop controls the cursor movement in RTL mode, whether it should be **visual** (pressing the left arrow moves the cursor left) or **logical** (pressing the left arrow moves to the next lower index in the string, which is visually right in RTL text).\n\n```js\n---\ntype: example\n---\nclass DirectionExample extends React.Component {\n state = {\n contextDir: 'unset',\n editorDir: 'unset',\n rtlMoveVisually: true,\n }\n\n render () {\n return (\n \n \n \n \n {\n this.setState({contextDir})\n }}\n >\n {['unset', 'ltr', 'rtl'].map(dir => )}\n \n {\n this.setState({editorDir})\n }}\n >\n {['unset', 'ltr', 'rtl'].map(dir => )}\n \n {\n this.setState({ rtlMoveVisually: !this.state.rtlMoveVisually })\n }}\n />\n \n \n\n \n \n \n )\n }\n}\n\nrender()\n```\n\n### Focus management\n\nBy default, SourceCodeEditor is tabbable/focusable, and once it is in focus, tabbing will move the focus on the page. These behaviours can be changed with the [editable](/#SourceCodeEditor/#editable-and-readonly) and [indentWithTab](/#SourceCodeEditor/#indentation-indent-with-tab) props.\n\nThe `autofocus` prop will automatically focus the editor on the initial render.\n\nYou can also manually focus the editor with its public `focus` method (the `hasFocus` getter is also available).\n\n```js\n---\ntype: example\n---\nclass FocusExample extends React.Component {\n state = {\n indentWithTab: true,\n indentUnitCount: '2',\n }\n\n editor = null\n\n render () {\n return (\n \n \n \n \n\n { this.editor = component }}\n language=\"jsx\"\n onFocus={() => {\n console.log('onFocus')\n console.log({ hasFocus: this.editor.hasFocus })\n }}\n onBlur={() => {\n console.log('onBlur')\n console.log({ hasFocus: this.editor.hasFocus })\n }}\n defaultValue={`function exampleMethod(props: Props) {\n return props ? props.value : null\n}`}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Attachment\n\nThe `attachment` prop removes the top/bottom border-radius and margin of the editor, so it can be attached to the top or bottom of another element.\n\n```js\n---\ntype: example\n---\nclass AttachmentExample extends React.Component {\n state = {\n attachment: 'none'\n }\n\n render () {\n const viewProps = {\n as: 'div',\n background: 'primary-inverse',\n padding: 'small'\n }\n\n return (\n \n \n {\n this.setState({attachment})\n }}\n >\n {['none', 'top', 'bottom'].map(attachment => )}\n \n \n\n {this.state.attachment === 'bottom' && (\n \n CodeEditor is attached to the bottom of this element\n \n )}\n \n {this.state.attachment === 'top' && (\n \n CodeEditor is attached to the top of this element\n \n )}\n \n )\n }\n}\n\nrender()\n```\n\n### Search\n\nTo enable the search panel use the `searchConfig` prop.\n\nYou can open the search panel in the code editor by pressing `cmd/ctrl+f` when the editor is in focus (otherwise the browser's search will open). The reason you would use this instead of the browser native search is because it will miss results that are far out of view in the text rendered by the editor. This is the limitation of the underlying CodeMirror component.\n\nHitting `Enter` jumps to the next result and `Shift+Enter` to the previous. Alternatively you can use the up and down buttons to the right of the input field.\n\nPlacement: the search panel will open at the bottom of the editor. This cannot be changed unfortunately due to a limitation in CodeMirror.\n\n```js\n---\ntype: example\n---\n\n```\n","displayName":"SourceCodeEditor","methods":[],"props":{"label":{"type":{"name":"string"},"required":true,"description":"The label text that screen readers will read when this component gets\nfocus.","tsType":{"name":"string"}},"language":{"type":{"name":"enum","value":[{"value":"'sh'","computed":false},{"value":"'js'","computed":false},{"value":"'json'","computed":false},{"value":"'javascript'","computed":false},{"value":"'jsx'","computed":false},{"value":"'shell'","computed":false},{"value":"'css'","computed":false},{"value":"'html'","computed":false},{"value":"'markdown'","computed":false},{"value":"'yaml'","computed":false},{"value":"'yml'","computed":false},{"value":"'bash'","computed":false}]},"required":false,"description":"The language to use (adds autocomplete and syntax highlighting).","tsType":{"name":"union","raw":"| 'sh'\n| 'js'\n| 'json'\n| 'javascript'\n| 'jsx'\n| 'shell'\n| 'css'\n| 'html'\n| 'markdown'\n| 'yaml'\n| 'yml'\n| 'bash'","elements":[{"name":"literal","value":"'sh'"},{"name":"literal","value":"'js'"},{"name":"literal","value":"'json'"},{"name":"literal","value":"'javascript'"},{"name":"literal","value":"'jsx'"},{"name":"literal","value":"'shell'"},{"name":"literal","value":"'css'"},{"name":"literal","value":"'html'"},{"name":"literal","value":"'markdown'"},{"name":"literal","value":"'yaml'"},{"name":"literal","value":"'yml'"},{"name":"literal","value":"'bash'"}]},"defaultValue":{"value":"'jsx'","computed":false}},"readOnly":{"type":{"name":"bool"},"required":false,"description":"This disables editing of the editor content by the user and API calls.\n\n__Note:__ The editor is still focusable in readOnly mode. Read more at the [codemirror documentation](https://codemirror.net/6/docs/ref/#state.EditorState%5EreadOnly).","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"editable":{"type":{"name":"bool"},"required":false,"description":"Controls whether the editor content DOM is editable.\n\n__Note:__ When set to false, the editor is not focusable.\n(This doesn't affect API calls that change the editor content, e.g.: copy-paste,\neven when those are bound to keys or buttons.) Read more at the [codemirror documentation](https://codemirror.net/6/docs/ref/#view.EditorView%5Eeditable).","tsType":{"name":"boolean"},"defaultValue":{"value":"true","computed":false}},"lineNumbers":{"type":{"name":"bool"},"required":false,"description":"Whether to display the line numbers in the gutter","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"foldGutter":{"type":{"name":"bool"},"required":false,"description":"Whether to show a fold status indicator before foldable lines (which can be clicked to fold or unfold the line)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"highlightActiveLineGutter":{"type":{"name":"bool"},"required":false,"description":"Whether to highlight gutter elements on the active line (visible only when a gutter is visible)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"highlightActiveLine":{"type":{"name":"bool"},"required":false,"description":"Highlights the lines that have a cursor on them","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"lineWrapping":{"type":{"name":"bool"},"required":false,"description":"Whether it should scroll or wrap for long lines. Defaults to false (scroll)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"autofocus":{"type":{"name":"bool"},"required":false,"description":"Whether the editor should focus itself on initialization","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"spellcheck":{"type":{"name":"bool"},"required":false,"description":"Whether spellcheck will be enabled on the input","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"direction":{"type":{"name":"enum","value":[{"value":"'ltr'","computed":false},{"value":"'rtl'","computed":false}]},"required":false,"description":"Flips overall layout and selects base paragraph direction to be \"LTR\" or \"RTL\".","tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]}},"rtlMoveVisually":{"type":{"name":"bool"},"required":false,"description":"Whether horizontal cursor movement through \"RTL\" text is visual\n(pressing the left arrow moves the cursor left) or logical\n(pressing the left arrow moves to the next lower index in the string,\nwhich is visually right in \"RTL\" text)","tsType":{"name":"boolean"},"defaultValue":{"value":"true","computed":false}},"indentOnLoad":{"type":{"name":"bool"},"required":false,"description":"Whether the editor should auto-indent the code on this initial load\nand when the `value` is changed","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"indentWithTab":{"type":{"name":"bool"},"required":false,"description":"When this feature is on, Tab and Shift-Tab will indent the code. By default, it is turned off, and tabbing will focus the next element in the tab order.\n\n__Note__: Even if this feature is on, pressing Escape before tabbing will not handle indentation and will handle focus instead.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"indentUnit":{"type":{"name":"string"},"required":false,"description":"Overrides the unit by which indentation happens (defaults to 2 spaces).\nShould be a string consisting either entirely of spaces or entirely of tabs.","tsType":{"name":"string"}},"defaultValue":{"type":{"name":"string"},"required":false,"description":"The default value of the editor (in uncontrolled mode)","tsType":{"name":"string"},"defaultValue":{"value":"''","computed":false}},"value":{"type":{"name":"custom","raw":"controllable(PropTypes.string, 'onChange', 'defaultValue')"},"required":false,"description":"The selected value for the controlled version\n(needs an onChange handler to work)","tsType":{"name":"string"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Called when the value of the component changes.","tsType":{"name":"signature","type":"function","raw":"(value: string) => void","signature":{"arguments":[{"type":{"name":"string"},"name":"value"}],"return":{"name":"void"}}}},"onFocus":{"type":{"name":"func"},"required":false,"description":"Called when the editor receives focus","tsType":{"name":"signature","type":"function","raw":"() => void","signature":{"arguments":[],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Called when the editor loses focus","tsType":{"name":"signature","type":"function","raw":"() => void","signature":{"arguments":[],"return":{"name":"void"}}}},"attachment":{"type":{"name":"enum","value":[{"value":"'bottom'","computed":false},{"value":"'top'","computed":false}]},"required":false,"description":"Sets minor visual styles (border radius & top/bottom margin)","tsType":{"name":"union","raw":"'bottom' | 'top'","elements":[{"name":"literal","value":"'bottom'"},{"name":"literal","value":"'top'"}]}},"height":{"type":{"name":"string"},"required":false,"description":"The height of the editor.","tsType":{"name":"string"},"defaultValue":{"value":"'auto'","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"The width of the editor.","tsType":{"name":"string"}},"elementRef":{"type":{"name":"func"},"required":false,"description":"provides a reference to the underlying html root element","tsType":{"name":"signature","type":"function","raw":"(element: HTMLDivElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLDivElement | null","elements":[{"name":"HTMLDivElement"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"containerRef":{"type":{"name":"func"},"required":false,"description":"provides a reference to the html element of the editor's container","tsType":{"name":"signature","type":"function","raw":"(element: HTMLDivElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLDivElement | null","elements":[{"name":"HTMLDivElement"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"searchConfig":{"type":{"name":"object"},"required":false,"description":"enable search panel in editor when pressing ctrl/cmd+f","tsType":{"name":"signature","type":"object","raw":"{\n placeholder: string\n nextResultLabel: string\n prevResultLabel: string\n}","signature":{"properties":[{"key":"placeholder","value":{"name":"string","required":true}},{"key":"nextResultLabel","value":{"name":"string","required":true}},{"key":"prevResultLabel","value":{"name":"string","required":true}}]}}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx","extension":".tsx","srcPath":"packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx","packageName":"@instructure/ui-source-code-editor","requirePath":"@instructure/ui-source-code-editor/lib/SourceCodeEditor/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx').default","esPath":"@instructure/ui-source-code-editor/es/SourceCodeEditor/index","themePath":"packages/ui-source-code-editor/src/SourceCodeEditor/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-source-code-editor/src/SourceCodeEditor/theme.ts","id":"SourceCodeEditor","title":"SourceCodeEditor"} \ No newline at end of file +{"description":"\nA wrapper around the popular [CodeMirror](https://codemirror.net/) code editor component. CodeMirror provides a text input field with features like line gutters, syntax highlighting, and autocompletion.\n\n```javascript\n---\ntype: embed\n---\n\n \n If you are currently using our CodeEditor component, we suggest upgrading to SourceCodeEditor, because it has many more features and is way more accessible.\n \n \n See the migration guide at the bottom of the CodeEditor docs page for more info.\n \n\n```\n\n### Built-in features\n\nSourceCodeEditor has a lot of built-in features that makes editing code easier.\n\n##### Command keybinding\n\nThe editor has a lot of handy key bindings for commands like copying and deleting lines, moving lines up and down, selection and indentation, etc. See the keymaps here: [defaultKeymap](https://codemirror.net/docs/ref/#commands.defaultKeymap), [closeBracketsKeymap](https://codemirror.net/docs/ref/#autocomplete.closeBracketsKeymap), [historyKeymap](https://codemirror.net/docs/ref/#commands.historyKeymap), [foldKeymap](https://codemirror.net/docs/ref/#language.foldKeymap), [completionKeymap](https://codemirror.net/docs/ref/#autocomplete.completionKeymap), [lintKeymap](https://codemirror.net/docs/ref/#lint.lintKeymap).\n\n##### History\n\nThe history feature remembers the steps of the code editing and selections, and lets you undo and redo them.\n\n##### Cursor and selection\n\nInstead of using the browser's native selection and cursor, SourceCodeEditor uses its own system. This allows the editor to display secondary selection ranges, and tends to produce a type of selection more in line with that users expect in a text editor.\n\nIt also allows **multiple** cursors to be placed (`Cmd/Ctrl` + click), multiple ranges to be selected and edited at the same time.\n\n**Rectangular selections:** by default, it will react to left mouse drag with the `Option/Alt` key held down. When such a selection occurs, the text within the rectangle that was dragged over will be selected, as one selection range per line.\n\nThe editor highlights text that matches the current selection.\n\n##### Bracket matching and closing\n\nWhenever the cursor is next to a bracket, that bracket and the one it matches are highlighted. Or, when no matching bracket is found, another highlighting style is used to indicate this.\n\nWhen a closeable bracket is typed, its closing bracket is immediately inserted after the cursor.\n\n### Language support\n\nSetting the correct language adds **syntax highlighting** and other helpful features to the editor, like **code folding**, **auto-indentation**, **syntax-aware selection** and **autocompletion** features.\n\n**Note:** In case you need support for additional languages, please contact us on [GitHub](https://github.com/instructure/instructure-ui)!\n\n```js\n---\ntype: example\n---\n\nconst languages = {\n json: `{\n \"name\": \"@instructure/ui-source-code-editor\",\n \"version\": \"8.24.2\",\n \"description\": \"A UI component library made by Instructure Inc.\",\n \"author\": \"Instructure, Inc. Engineering and Product Design\",\n \"module\": \"./es/index.js\",\n \"main\": \"./lib/index.js\",\n \"types\": \"./types/index.d.ts\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/instructure/instructure-ui.git\"\n },\n}`,\n javascript: `const fruit: string = \"apple\"\n\nconst re = new RegExp('ab+c')\n\nfunction exampleMethod(props: Props) {\n return props ? props.value : null\n}\n\n/**\n * This is an example\n * @param {Object} props\n */\nconst Example = () => {\n return (\n \n }\n placement='end center'\n offsetX='20px'\n >\n \n Positioned content\n \n \n \n )\n}\n\nrender()`,\n html: `\n\n \n \n \n \n Example app\n \n \n
\n \n
\n\n \n \n`,\n css: `a {\n text-decoration: none;\n\n &:hover { text-decoration: underline; }\n}\n\na:link, a:visited, a:hover, a:active {\n background-color: green;\n color: white;\n padding: 10px 25px;\n text-align: center;\n text-decoration: none;\n display: inline-block;\n}\n\n.centertext { text-align: center; }\n\nimg { opacity: 0.5; filter: alpha(opacity=50); }`,\n markdown: `#### The quarterly results look great!\n\n> - Revenue was off the chart.\n> - Profits were higher than ever.\n\n*Everything* is going according to **plan**.\n\n---\ntype: example\n---`,\n shell: `#!/bin/bash\n\n# example of using arguments to a script\necho \"My first name is $1\"\necho \"My surname is $2\"\necho \"Total number of arguments is $#\"\n\n________________________________________\n\n$ chmod a+x name.sh\n$ ./name.sh Hans-Wolfgang Loidl\nMy first name is Hans-Wolfgang\nMy surname is Loidl\nTotal number of arguments is 2`,\n yml: `---\n doe: \"a deer, a female deer\"\n ray: \"a drop of golden sun\"\n pi: 3.14159\n xmas: true\n french-hens: 3\n calling-birds:\n - huey\n - dewey\n - louie\n - fred\n xmas-fifth-day:\n calling-birds: four\n french-hens: 3\n golden-rings: 5\n partridges:\n count: 1\n location: \"a pear tree\"\n turtle-doves: two`\n}\n\nconst languageMap = {\n json: languages.json,\n js: languages.javascript,\n jsx: languages.javascript,\n javascript: languages.javascript,\n html: languages.html,\n css: languages.css,\n markdown: languages.markdown,\n sh: languages.shell,\n shell: languages.shell,\n bash: languages.shell,\n yml: languages.yml,\n yaml: languages.yml,\n}\n\nclass LanguageExamples extends React.Component {\n state = {\n currentLanguage: 'javascript',\n currentValue: languageMap.javascript,\n }\n\n render() {\n const languageKeys = Object.keys(languageMap)\n\n return (\n \n \n {\n this.setState({\n currentLanguage,\n currentValue: languageMap[currentLanguage]\n })\n }}\n >\n {languageKeys.map(language => (\n ))}\n \n \n\n \n \n {\n this.setState({\n currentValue: value\n })\n }}\n lineNumbers\n lineWrapping\n highlightActiveLine\n highlightActiveLineGutter\n />\n \n \n \n )\n }\n}\n\nrender()\n\n```\n\n### Controlled mode\n\nSourceCodeEditor works best as an uncontrolled component (with the `defaultValue` prop), and that is how we recommend it to be used. As an uncontrolled component, the underlying CodeMirror component can take care of all interactions.\n\nWe've implemented the \"controlled\" usage, but please let us know if you run into any performance issues or bugs.\n\n```js\n---\ntype: example\n---\nclass ControlledExample extends React.Component {\n state = {\n value: `const fruit: string = \"apple\"\n\nfunction exampleMethod(props: Props) {\n return props ? props.value : null\n}`\n }\n\n textAreaRef = null\n\n render () {\n return (\n \n \n \n \n {\n this.setState({ value })\n }}\n highlightActiveLine\n highlightActiveLineGutter\n lineWrapping\n lineNumbers\n foldGutter\n spellcheck\n />\n \n \n \n \n Change value}\n textareaRef={(e) => { this.textAreaRef = e }}\n defaultValue={this.state.value}\n />\n \n \n \n \n \n )\n }\n}\n\nrender()\n```\n\n### Editable and readOnly\n\nThe editability of the content can be set with the combination of the `editable` and `readOnly` props.\n\nThe `readOnly` prop works like a \"preventDefault\" and disables any interaction by the user or API calls (e.g. copy-paste).\nIf the `editable` prop is set to `false`, the editor is also not focusable, and the `contenteditable=\"false\"` is set on the content.\n\n```js\n---\ntype: example\n---\nclass EditableExample extends React.Component {\n state = {\n editable: true,\n readOnly: false\n }\n\n render () {\n return (\n \n \n \n {['editable', 'readOnly'].map((prop) => (\n {\n this.setState({ [prop]: !this.state[prop] })\n }}\n />\n ))}\n \n \n\n \n \n )\n }\n}\n\nrender()\n```\n\n### Gutter settings\n\nThe `lineNumbers` prop displays the line numbers in the side gutter, and the `foldGutter` prop displays the toggleable fold icon next to foldable code blocks.\n\nIf any of these two props are active, the gutter is displayed, and the `highlightActiveLineGutter` highlights the active line in the gutter. (The `highlightActiveLine` prop highlights the line itself.)\n\n```js\n---\ntype: example\n---\nclass GutterExample extends React.Component {\n state = {\n lineNumbers: true,\n foldGutter: true,\n highlightActiveLineGutter: true,\n highlightActiveLine: true,\n }\n\n render () {\n return (\n \n \n \n {['lineNumbers', 'foldGutter', 'highlightActiveLineGutter', 'highlightActiveLine'].map((prop) => (\n {\n this.setState({ [prop]: !this.state[prop] })\n }}\n />\n ))}\n \n \n\n {\n return (\n \n }\n placement='end center'\n offsetX='20px'\n >\n \n Positioned content\n \n \n \n )\n}\n\nrender()`}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Indentation\n\n##### auto-indent\n\nThe editor automatically indents the lines on input. The `indentOnLoad` prop indents the code on the initial load and when the `value` prop is updated.\n\n##### indent with tab\n\nWhen the `indentWithTab` feature is turned on, Tab and Shift-Tab will indent the code.\nBy default, it is turned off, and tabbing will focus the next element in the tab order.\n\n**Accessibility note**: Even if `indentWithTab` is on, pressing Escape before tabbing will not handle indentation and will handle focus instead. When using this feature, it is recommended to add info about this behaviour in your documentation.\n\n##### indent unit\n\nYou can also override the unit by which indentation happens (defaults to 2 spaces).\nThe `indentUnitCount` prop should be a string consisting either entirely of spaces or entirely of tabs.\n\n##### manual re-indent\n\nAnother useful feature is the `indentAll` public method on the `SourceCodeEditor` component that can be called anytime to trigger a re-indent on the content.\n\n```js\n---\ntype: example\n---\nclass IndentExample extends React.Component {\n state = {\n indentWithTab: true,\n indentUnitCount: '2',\n }\n\n editor = null\n\n get indentUnit() {\n return Array(parseInt(this.state.indentUnitCount)).fill(' ').join('')\n }\n\n reIndent () {\n this.editor.indentAll()\n }\n\n indentCurrentSelection () {\n this.editor.indentCurrentSelection()\n }\n\n render () {\n return (\n \n \n \n {\n this.setState({ indentWithTab: !this.state.indentWithTab })\n }}\n />\n {\n this.setState({indentUnitCount})\n this.reIndent()\n }}\n >\n {['2', '4', '8'].map(count => )}\n \n \n \n \n \n\n { this.editor = component }}\n language=\"jsx\"\n indentWithTab={this.state.indentWithTab}\n indentUnit={this.indentUnit}\n defaultValue={`const fruit: string = \"apple\"\n\nfunction exampleMethod(props: Props) {\n return props ? props.value : null\n}\n\n/**\n * This is an example\n * @param {Object} props\n */\nconst Example = () => {\n return (\n \n }\n placement='end center'\n offsetX='20px'\n >\n \n Positioned content\n \n \n \n )\n}\n\nrender()`}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Direction\n\nSourceCodeEditor is a bidirectional component. It will inherit the text-direction from the context, and can be set directly on the component with the `direction` prop. The `rtl` mode will flip the overall layout and selects base paragraph direction to RTL.\n\nThe `rtlMoveVisually` prop controls the cursor movement in RTL mode, whether it should be **visual** (pressing the left arrow moves the cursor left) or **logical** (pressing the left arrow moves to the next lower index in the string, which is visually right in RTL text).\n\n```js\n---\ntype: example\n---\nclass DirectionExample extends React.Component {\n state = {\n contextDir: 'unset',\n editorDir: 'unset',\n rtlMoveVisually: true,\n }\n\n render () {\n return (\n \n \n \n \n {\n this.setState({contextDir})\n }}\n >\n {['unset', 'ltr', 'rtl'].map(dir => )}\n \n {\n this.setState({editorDir})\n }}\n >\n {['unset', 'ltr', 'rtl'].map(dir => )}\n \n {\n this.setState({ rtlMoveVisually: !this.state.rtlMoveVisually })\n }}\n />\n \n \n\n \n \n \n )\n }\n}\n\nrender()\n```\n\n### Focus management\n\nBy default, SourceCodeEditor is tabbable/focusable, and once it is in focus, tabbing will move the focus on the page. These behaviours can be changed with the [editable](/#SourceCodeEditor/#editable-and-readonly) and [indentWithTab](/#SourceCodeEditor/#indentation-indent-with-tab) props.\n\nThe `autofocus` prop will automatically focus the editor on the initial render.\n\nYou can also manually focus the editor with its public `focus` method (the `hasFocus` getter is also available).\n\n```js\n---\ntype: example\n---\nclass FocusExample extends React.Component {\n state = {\n indentWithTab: true,\n indentUnitCount: '2',\n }\n\n editor = null\n\n render () {\n return (\n \n \n \n \n\n { this.editor = component }}\n language=\"jsx\"\n onFocus={() => {\n console.log('onFocus')\n console.log({ hasFocus: this.editor.hasFocus })\n }}\n onBlur={() => {\n console.log('onBlur')\n console.log({ hasFocus: this.editor.hasFocus })\n }}\n defaultValue={`function exampleMethod(props: Props) {\n return props ? props.value : null\n}`}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Attachment\n\nThe `attachment` prop removes the top/bottom border-radius and margin of the editor, so it can be attached to the top or bottom of another element.\n\n```js\n---\ntype: example\n---\nclass AttachmentExample extends React.Component {\n state = {\n attachment: 'none'\n }\n\n render () {\n const viewProps = {\n as: 'div',\n background: 'primary-inverse',\n padding: 'small'\n }\n\n return (\n \n \n {\n this.setState({attachment})\n }}\n >\n {['none', 'top', 'bottom'].map(attachment => )}\n \n \n\n {this.state.attachment === 'bottom' && (\n \n CodeEditor is attached to the bottom of this element\n \n )}\n \n {this.state.attachment === 'top' && (\n \n CodeEditor is attached to the top of this element\n \n )}\n \n )\n }\n}\n\nrender()\n```\n\n### Search\n\nTo enable the search panel use the `searchConfig` prop.\n\nYou can open the search panel in the code editor by pressing `cmd/ctrl+f` when the editor is in focus (otherwise the browser's search will open). The reason you would use this instead of the browser native search is because it will miss results that are far out of view in the text rendered by the editor. This is the limitation of the underlying CodeMirror component.\n\nHitting `Enter` jumps to the next result and `Shift+Enter` to the previous. Alternatively you can use the up and down buttons to the right of the input field.\n\nPlacement: the search panel will open at the bottom of the editor. This cannot be changed unfortunately due to a limitation in CodeMirror.\n\n```js\n---\ntype: example\n---\n\n```\n","displayName":"SourceCodeEditor","methods":[],"props":{"label":{"type":{"name":"string"},"required":true,"description":"The label text that screen readers will read when this component gets\nfocus.","tsType":{"name":"string"}},"language":{"type":{"name":"enum","value":[{"value":"'sh'","computed":false},{"value":"'js'","computed":false},{"value":"'json'","computed":false},{"value":"'javascript'","computed":false},{"value":"'jsx'","computed":false},{"value":"'shell'","computed":false},{"value":"'css'","computed":false},{"value":"'html'","computed":false},{"value":"'markdown'","computed":false},{"value":"'yaml'","computed":false},{"value":"'yml'","computed":false},{"value":"'bash'","computed":false}]},"required":false,"description":"The language to use (adds autocomplete and syntax highlighting).","tsType":{"name":"union","raw":"| 'sh'\n| 'js'\n| 'json'\n| 'javascript'\n| 'jsx'\n| 'shell'\n| 'css'\n| 'html'\n| 'markdown'\n| 'yaml'\n| 'yml'\n| 'bash'","elements":[{"name":"literal","value":"'sh'"},{"name":"literal","value":"'js'"},{"name":"literal","value":"'json'"},{"name":"literal","value":"'javascript'"},{"name":"literal","value":"'jsx'"},{"name":"literal","value":"'shell'"},{"name":"literal","value":"'css'"},{"name":"literal","value":"'html'"},{"name":"literal","value":"'markdown'"},{"name":"literal","value":"'yaml'"},{"name":"literal","value":"'yml'"},{"name":"literal","value":"'bash'"}]},"defaultValue":{"value":"'jsx'","computed":false}},"readOnly":{"type":{"name":"bool"},"required":false,"description":"This disables editing of the editor content by the user and API calls.\n\n__Note:__ The editor is still focusable in readOnly mode. Read more at the [codemirror documentation](https://codemirror.net/6/docs/ref/#state.EditorState%5EreadOnly).","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"editable":{"type":{"name":"bool"},"required":false,"description":"Controls whether the editor content DOM is editable.\n\n__Note:__ When set to false, the editor is not focusable.\n(This doesn't affect API calls that change the editor content, e.g.: copy-paste,\neven when those are bound to keys or buttons.) Read more at the [codemirror documentation](https://codemirror.net/6/docs/ref/#view.EditorView%5Eeditable).","tsType":{"name":"boolean"},"defaultValue":{"value":"true","computed":false}},"lineNumbers":{"type":{"name":"bool"},"required":false,"description":"Whether to display the line numbers in the gutter","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"foldGutter":{"type":{"name":"bool"},"required":false,"description":"Whether to show a fold status indicator before foldable lines (which can be clicked to fold or unfold the line)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"highlightActiveLineGutter":{"type":{"name":"bool"},"required":false,"description":"Whether to highlight gutter elements on the active line (visible only when a gutter is visible)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"highlightActiveLine":{"type":{"name":"bool"},"required":false,"description":"Highlights the lines that have a cursor on them","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"lineWrapping":{"type":{"name":"bool"},"required":false,"description":"Whether it should scroll or wrap for long lines. Defaults to false (scroll)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"autofocus":{"type":{"name":"bool"},"required":false,"description":"Whether the editor should focus itself on initialization","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"spellcheck":{"type":{"name":"bool"},"required":false,"description":"Whether spellcheck will be enabled on the input","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"direction":{"type":{"name":"enum","value":[{"value":"'ltr'","computed":false},{"value":"'rtl'","computed":false}]},"required":false,"description":"Flips overall layout and selects base paragraph direction to be \"LTR\" or \"RTL\".","tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]}},"rtlMoveVisually":{"type":{"name":"bool"},"required":false,"description":"Whether horizontal cursor movement through \"RTL\" text is visual\n(pressing the left arrow moves the cursor left) or logical\n(pressing the left arrow moves to the next lower index in the string,\nwhich is visually right in \"RTL\" text)","tsType":{"name":"boolean"},"defaultValue":{"value":"true","computed":false}},"indentOnLoad":{"type":{"name":"bool"},"required":false,"description":"Whether the editor should auto-indent the code on this initial load\nand when the `value` is changed","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"indentWithTab":{"type":{"name":"bool"},"required":false,"description":"When this feature is on, Tab and Shift-Tab will indent the code. By default, it is turned off, and tabbing will focus the next element in the tab order.\n\n__Note__: Even if this feature is on, pressing Escape before tabbing will not handle indentation and will handle focus instead.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"indentUnit":{"type":{"name":"string"},"required":false,"description":"Overrides the unit by which indentation happens (defaults to 2 spaces).\nShould be a string consisting either entirely of spaces or entirely of tabs.","tsType":{"name":"string"}},"defaultValue":{"type":{"name":"string"},"required":false,"description":"The default value of the editor (in uncontrolled mode)","tsType":{"name":"string"},"defaultValue":{"value":"''","computed":false}},"value":{"type":{"name":"custom","raw":"controllable(PropTypes.string, 'onChange', 'defaultValue')"},"required":false,"description":"The selected value for the controlled version\n(needs an onChange handler to work)","tsType":{"name":"string"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Called when the value of the component changes.","tsType":{"name":"signature","type":"function","raw":"(value: string) => void","signature":{"arguments":[{"type":{"name":"string"},"name":"value"}],"return":{"name":"void"}}}},"onFocus":{"type":{"name":"func"},"required":false,"description":"Called when the editor receives focus","tsType":{"name":"signature","type":"function","raw":"() => void","signature":{"arguments":[],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Called when the editor loses focus","tsType":{"name":"signature","type":"function","raw":"() => void","signature":{"arguments":[],"return":{"name":"void"}}}},"attachment":{"type":{"name":"enum","value":[{"value":"'bottom'","computed":false},{"value":"'top'","computed":false}]},"required":false,"description":"Sets minor visual styles (border radius & top/bottom margin)","tsType":{"name":"union","raw":"'bottom' | 'top'","elements":[{"name":"literal","value":"'bottom'"},{"name":"literal","value":"'top'"}]}},"height":{"type":{"name":"string"},"required":false,"description":"The height of the editor.","tsType":{"name":"string"},"defaultValue":{"value":"'auto'","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"The width of the editor.","tsType":{"name":"string"}},"elementRef":{"type":{"name":"func"},"required":false,"description":"provides a reference to the underlying html root element","tsType":{"name":"signature","type":"function","raw":"(element: HTMLDivElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLDivElement | null","elements":[{"name":"HTMLDivElement"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"containerRef":{"type":{"name":"func"},"required":false,"description":"provides a reference to the html element of the editor's container","tsType":{"name":"signature","type":"function","raw":"(element: HTMLDivElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLDivElement | null","elements":[{"name":"HTMLDivElement"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"searchConfig":{"type":{"name":"object"},"required":false,"description":"enable search panel in editor when pressing ctrl/cmd+f","tsType":{"name":"signature","type":"object","raw":"{\n placeholder: string\n nextResultLabel: string\n prevResultLabel: string\n}","signature":{"properties":[{"key":"placeholder","value":{"name":"string","required":true}},{"key":"nextResultLabel","value":{"name":"string","required":true}},{"key":"prevResultLabel","value":{"name":"string","required":true}}]}}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx","extension":".tsx","srcPath":"packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx","packageName":"@instructure/ui-source-code-editor","requirePath":"@instructure/ui-source-code-editor/lib/SourceCodeEditor/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-source-code-editor/src/SourceCodeEditor/index.tsx').default","esPath":"@instructure/ui-source-code-editor/es/SourceCodeEditor/index","themePath":"packages/ui-source-code-editor/src/SourceCodeEditor/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-source-code-editor/src/SourceCodeEditor/theme.ts","id":"SourceCodeEditor","title":"SourceCodeEditor"} \ No newline at end of file diff --git a/pr-preview/pr-1812/docs/TextDirectionContext.json b/pr-preview/pr-1812/docs/TextDirectionContext.json index a57bcfc9b5..ad5b76de6b 100644 --- a/pr-preview/pr-1812/docs/TextDirectionContext.json +++ b/pr-preview/pr-1812/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":"0nm0ee8mhwbfyntblk5ns8.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":"uqabuzlnxflo61tt4vbm.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-1812/docs/ThemeRegistry.json b/pr-preview/pr-1812/docs/ThemeRegistry.json index daddbd11dc..8ce4661100 100644 --- a/pr-preview/pr-1812/docs/ThemeRegistry.json +++ b/pr-preview/pr-1812/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":"2p2cmvovj97mo0kkabtd99.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":"13pq2zioglg8h3dgo00x0x4.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-1812/docs/ThemeablePropTypes.json b/pr-preview/pr-1812/docs/ThemeablePropTypes.json index c39f955ba3..ba6794b685 100644 --- a/pr-preview/pr-1812/docs/ThemeablePropTypes.json +++ b/pr-preview/pr-1812/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":"vvc1qh0qzeblck20fu2pq.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":"vejbdfk3mc9abzzv2djlar.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-1812/docs/TopNavBarContext.json b/pr-preview/pr-1812/docs/TopNavBarContext.json index 4104fc370b..9f209fc960 100644 --- a/pr-preview/pr-1812/docs/TopNavBarContext.json +++ b/pr-preview/pr-1812/docs/TopNavBarContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module TopNavBarContext\n**/","meta":{"filename":"5b0e518913yzfs1vm2ht4.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":"q0351t13bsh8dxs11bxzo4.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-1812/docs/addElementQueryMatchListener.json b/pr-preview/pr-1812/docs/addElementQueryMatchListener.json index d9324c9e36..4e1860a75f 100644 --- a/pr-preview/pr-1812/docs/addElementQueryMatchListener.json +++ b/pr-preview/pr-1812/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":"32d8t5aqu1701ybjtzqurfb.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":"z1wet2iiocb2xfl9spgdv8.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-1812/docs/addEventListener.json b/pr-preview/pr-1812/docs/addEventListener.json index b81cbc2dc4..73d9a6e699 100644 --- a/pr-preview/pr-1812/docs/addEventListener.json +++ b/pr-preview/pr-1812/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":"tvx04xgkf17bs0vnygxdku.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":"e0st5lsi0j6ujngy371qx.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-1812/docs/addMediaQueryMatchListener.json b/pr-preview/pr-1812/docs/addMediaQueryMatchListener.json index 0a89f58e1b..15c61462bd 100644 --- a/pr-preview/pr-1812/docs/addMediaQueryMatchListener.json +++ b/pr-preview/pr-1812/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":"ei0zyaa53f8wd537ysd51.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":"xggf6rua1ykosszw9slzmp.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-1812/docs/addPositionChangeListener.json b/pr-preview/pr-1812/docs/addPositionChangeListener.json index bb484d2594..5c6763b6d8 100644 --- a/pr-preview/pr-1812/docs/addPositionChangeListener.json +++ b/pr-preview/pr-1812/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":"z6b5rmivwjgxg3iwfvwbw8.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":"z6b5rmivwjgxg3iwfvwbw8","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:z6b5rmivwjgxg3iwfvwbw8","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":"btnxptgnd6pdzny388um7v.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":"btnxptgnd6pdzny388um7v","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:btnxptgnd6pdzny388um7v","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-1812/docs/alpha.json b/pr-preview/pr-1812/docs/alpha.json index 3e25417148..e0fb506ee9 100644 --- a/pr-preview/pr-1812/docs/alpha.json +++ b/pr-preview/pr-1812/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":"zl5qnhplwuisaf6dl94ur.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":"ecf2nsj33mh6aifhwzcmk.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-1812/docs/calculateElementPosition.json b/pr-preview/pr-1812/docs/calculateElementPosition.json index e9bf37fdf2..f43469109a 100644 --- a/pr-preview/pr-1812/docs/calculateElementPosition.json +++ b/pr-preview/pr-1812/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":"kguk4ss0sk24ulucan4uw.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":"kguk4ss0sk24ulucan4uw","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:kguk4ss0sk24ulucan4uw","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":"gd8d9oadz58hgynv5zwvj.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":"gd8d9oadz58hgynv5zwvj","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:gd8d9oadz58hgynv5zwvj","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-1812/docs/callRenderProp.json b/pr-preview/pr-1812/docs/callRenderProp.json index d0c7638067..14e3b6733c 100644 --- a/pr-preview/pr-1812/docs/callRenderProp.json +++ b/pr-preview/pr-1812/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":"jz764jm17g9qnuvyiq1lf9.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":"pli58el9ovnipb5hwbpg9.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-1812/docs/camelize.json b/pr-preview/pr-1812/docs/camelize.json index 2ce6d76797..f0b50b0601 100644 --- a/pr-preview/pr-1812/docs/camelize.json +++ b/pr-preview/pr-1812/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":"g2a7rd7d0isoq7jst9h4.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":"b1zta4uz1un0pf749szcs.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-1812/docs/canUseDOM.json b/pr-preview/pr-1812/docs/canUseDOM.json index e4eb4e8769..880a2667a7 100644 --- a/pr-preview/pr-1812/docs/canUseDOM.json +++ b/pr-preview/pr-1812/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":"v2w7h8dfyk4ts0fify2me.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"v2w7h8dfyk4ts0fify2me","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:v2w7h8dfyk4ts0fify2me","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":"lhus3png9ytz6gdm47kh3i.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"lhus3png9ytz6gdm47kh3i","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:lhus3png9ytz6gdm47kh3i","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-1812/docs/capitalizeFirstLetter.json b/pr-preview/pr-1812/docs/capitalizeFirstLetter.json index 7f961b4914..2f10899a90 100644 --- a/pr-preview/pr-1812/docs/capitalizeFirstLetter.json +++ b/pr-preview/pr-1812/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":"uo7hqakicplrwykw8awy.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":"28nk2l8vk9ccw9n86kd6gp.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-1812/docs/childrenOrValue.json b/pr-preview/pr-1812/docs/childrenOrValue.json index f155008c2e..a839159aa4 100644 --- a/pr-preview/pr-1812/docs/childrenOrValue.json +++ b/pr-preview/pr-1812/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":"i133keydyuc1k27p5q4ial.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":"3qfnny5cfpm7r3y2ayzrrn.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-1812/docs/cloneArray.json b/pr-preview/pr-1812/docs/cloneArray.json index 07d3e99346..a317726632 100644 --- a/pr-preview/pr-1812/docs/cloneArray.json +++ b/pr-preview/pr-1812/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":"lvjdxso7p9fkjuz6ukshgf.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":"jfvae4ge1io1j69f59vxq.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-1812/docs/contains.json b/pr-preview/pr-1812/docs/contains.json index 5e939a41d3..52b957a244 100644 --- a/pr-preview/pr-1812/docs/contains.json +++ b/pr-preview/pr-1812/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":"27nuu042lchfvspoog1tr.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":"b2fettfpq2uysws9nkzql.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-1812/docs/containsActiveElement.json b/pr-preview/pr-1812/docs/containsActiveElement.json index 043ebdea85..7d5d05c395 100644 --- a/pr-preview/pr-1812/docs/containsActiveElement.json +++ b/pr-preview/pr-1812/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":"jvzr6d229ohbqkhtgdb8en.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":"fpseeae0vptd2vu2518vat.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-1812/docs/contrast.json b/pr-preview/pr-1812/docs/contrast.json index e09be2dec5..8390093c47 100644 --- a/pr-preview/pr-1812/docs/contrast.json +++ b/pr-preview/pr-1812/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":"s943ceo5rvrvs0lorng7sh.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":"k5veov2fy122659u5nt3s.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-1812/docs/contrastWithAlpha.json b/pr-preview/pr-1812/docs/contrastWithAlpha.json index 6861b68881..289b97e8d5 100644 --- a/pr-preview/pr-1812/docs/contrastWithAlpha.json +++ b/pr-preview/pr-1812/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":"ujyktxccnqk9xfnkkbd0u7.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":"0nc07m074ypkkiqgy9x66gr.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-1812/docs/controllable.json b/pr-preview/pr-1812/docs/controllable.json index cb44112cde..5202c73750 100644 --- a/pr-preview/pr-1812/docs/controllable.json +++ b/pr-preview/pr-1812/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":"ji46i5libhol7bqldeok7r.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":"hkp0hp0ya44x0p9vvi6a68.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-1812/docs/conversions.json b/pr-preview/pr-1812/docs/conversions.json index 7347401d6e..902578634c 100644 --- a/pr-preview/pr-1812/docs/conversions.json +++ b/pr-preview/pr-1812/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":"8zdtfa5098l0wl9jd8j9ps.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":"1zlk6gmq2sej3weyybig8dz.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-1812/docs/createChainedFunction.json b/pr-preview/pr-1812/docs/createChainedFunction.json index fb6cb2eb7f..11f18bb8eb 100644 --- a/pr-preview/pr-1812/docs/createChainedFunction.json +++ b/pr-preview/pr-1812/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":"33fgnjo1f7ulv2p4qsd4ul.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":"9i5pcbkkx9wg9qxwyi3buj.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-1812/docs/cursor.json b/pr-preview/pr-1812/docs/cursor.json index 849dcbe204..8810c96012 100644 --- a/pr-preview/pr-1812/docs/cursor.json +++ b/pr-preview/pr-1812/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":"z8h3qvfzk2fy71a5wymcma.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":"qp271lkq4em6c9456v1n.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-1812/docs/darken.json b/pr-preview/pr-1812/docs/darken.json index 71d54f1d31..70fb6029c3 100644 --- a/pr-preview/pr-1812/docs/darken.json +++ b/pr-preview/pr-1812/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":"yngb77aw7nnvws229epx0g.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":"udgmw9up0fezqaju926s9.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-1812/docs/debounce.json b/pr-preview/pr-1812/docs/debounce.json index 46da284988..53e46f1ec5 100644 --- a/pr-preview/pr-1812/docs/debounce.json +++ b/pr-preview/pr-1812/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":"r1jso3tc0xp5xwalfhj9an.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":"azd8khptfs7n9esqm606t.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-1812/docs/decorator.json b/pr-preview/pr-1812/docs/decorator.json index 1b2e95c2be..b9f337a9ed 100644 --- a/pr-preview/pr-1812/docs/decorator.json +++ b/pr-preview/pr-1812/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":"5zz84bik137t70kb8x8i3f.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":"9gtck91wllqhvopa6bfgjl.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-1812/docs/deepEqual.json b/pr-preview/pr-1812/docs/deepEqual.json index ee85b4bcd9..2d466b54e9 100644 --- a/pr-preview/pr-1812/docs/deepEqual.json +++ b/pr-preview/pr-1812/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":"y1comqwnsea7adi2s2toc.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":"xub3sbb28arsrqe80ompe.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-1812/docs/deprecated.json b/pr-preview/pr-1812/docs/deprecated.json index 98c79179fe..a0fbe65fab 100644 --- a/pr-preview/pr-1812/docs/deprecated.json +++ b/pr-preview/pr-1812/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":"cpxygz1k9nug18g2s9payr.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":"8pfseam7zle4t7sc8670ra.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-1812/docs/element.json b/pr-preview/pr-1812/docs/element.json index 67f2dc5db9..c410bc4940 100644 --- a/pr-preview/pr-1812/docs/element.json +++ b/pr-preview/pr-1812/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":"yw3o9oek2991hyu3565kdc.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":"qn7su4s9vzf8u1b3tqdeu6.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-1812/docs/ensureSingleChild.json b/pr-preview/pr-1812/docs/ensureSingleChild.json index 16edea72c3..7261d932dc 100644 --- a/pr-preview/pr-1812/docs/ensureSingleChild.json +++ b/pr-preview/pr-1812/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":"805l0mnd4k647exe81e2pw.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":"39h3bmv3fswrj0bs1gmhf.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-1812/docs/experimental.json b/pr-preview/pr-1812/docs/experimental.json index 084de79241..ff71fd7c65 100644 --- a/pr-preview/pr-1812/docs/experimental.json +++ b/pr-preview/pr-1812/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":"28hyp8qez3oxiz92ml5blf.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":"d1osv3tm9b4p61zn4w5ubq.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-1812/docs/findDOMNode.json b/pr-preview/pr-1812/docs/findDOMNode.json index f5e8601ebd..302f19a85d 100644 --- a/pr-preview/pr-1812/docs/findDOMNode.json +++ b/pr-preview/pr-1812/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":"4vwpj08t05rwkicnmmyxf.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":"7qjhyfwpovrh2tnpy0kueo.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-1812/docs/findFocusable.json b/pr-preview/pr-1812/docs/findFocusable.json index ee20aba18e..0b1603adef 100644 --- a/pr-preview/pr-1812/docs/findFocusable.json +++ b/pr-preview/pr-1812/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":"e5etbkogzzemmdxpyp7h.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":"isvrrzsxvng1wk0lk16zo7.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-1812/docs/findTabbable.json b/pr-preview/pr-1812/docs/findTabbable.json index c2bc0c841d..706d1d173b 100644 --- a/pr-preview/pr-1812/docs/findTabbable.json +++ b/pr-preview/pr-1812/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":"6n8tc7dcisqr72bfik5bn.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":"fgscngk6tckuy98ach6knl.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-1812/docs/getActiveElement.json b/pr-preview/pr-1812/docs/getActiveElement.json index 2fb252553d..03b5ed40ee 100644 --- a/pr-preview/pr-1812/docs/getActiveElement.json +++ b/pr-preview/pr-1812/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":"kqq0047gul2i7xqaim5ju.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":"z6rhx9en0futc4y3nwast.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-1812/docs/getBoundingClientRect.json b/pr-preview/pr-1812/docs/getBoundingClientRect.json index 058e2fda7a..99ccf50e3e 100644 --- a/pr-preview/pr-1812/docs/getBoundingClientRect.json +++ b/pr-preview/pr-1812/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":"bas1d436hmeb6zc8qwy9.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":"9k3z2munuq90yjddw5eh.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-1812/docs/getBrowser.json b/pr-preview/pr-1812/docs/getBrowser.json index 6296580881..99ba2f7cfb 100644 --- a/pr-preview/pr-1812/docs/getBrowser.json +++ b/pr-preview/pr-1812/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":"p02bls8hhoe5os2d8pdd3y.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":"tsd3t8m5q39w9iz3qoso4.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-1812/docs/getClassList.json b/pr-preview/pr-1812/docs/getClassList.json index 9baaee8b1e..f73d680e26 100644 --- a/pr-preview/pr-1812/docs/getClassList.json +++ b/pr-preview/pr-1812/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":"gg6ccifg9poosa0jg5d5vr.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":"jqm4myne5opr7q8pi6t51.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-1812/docs/getComputedStyle.json b/pr-preview/pr-1812/docs/getComputedStyle.json index cbaf63a636..3e9b1ee6c9 100644 --- a/pr-preview/pr-1812/docs/getComputedStyle.json +++ b/pr-preview/pr-1812/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":"knwc8t6786cyzpgadx4y.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":"a0c7bqvc1yvqa4fmeczoln.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-1812/docs/getDisplayName.json b/pr-preview/pr-1812/docs/getDisplayName.json index 10aed32dce..21b9a09bd6 100644 --- a/pr-preview/pr-1812/docs/getDisplayName.json +++ b/pr-preview/pr-1812/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":"0h8ysgreexismh7bq45xgti.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":"3m662gtx3utjgbki74w8bq.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-1812/docs/getElementType.json b/pr-preview/pr-1812/docs/getElementType.json index df57b8ee23..52769f5888 100644 --- a/pr-preview/pr-1812/docs/getElementType.json +++ b/pr-preview/pr-1812/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. `