From 20a0f8c919492d829841130c8ed33361d5cbf892 Mon Sep 17 00:00:00 2001 From: balzss Date: Wed, 2 Oct 2024 11:52:49 +0000 Subject: [PATCH] =?UTF-8?q?Deploy=20preview=20for=20PR=201690=20?= =?UTF-8?q?=F0=9F=9B=AB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...dcf49fec6.eot => 06a08f6e0c92d8f3d28a.eot} | Bin 77956 -> 77956 bytes ...34aa4691b.ttf => 32c18c125387e88f9120.ttf} | Bin 77736 -> 77736 bytes ...a9b1b3d26.ttf => 34e1595fa073ccba9042.ttf} | Bin 64620 -> 64620 bytes ...cb058ef.woff => 5aa5decd41057c35b521.woff} | Bin 36932 -> 36932 bytes ...c82f17418.eot => c8036fe200dd8d7701b9.eot} | Bin 64844 -> 64844 bytes pr-preview/pr-1690/docs/Calendar.json | 2 +- pr-preview/pr-1690/docs/Checkbox.json | 2 +- pr-preview/pr-1690/docs/Children.json | 2 +- pr-preview/pr-1690/docs/DateInput.json | 2 +- pr-preview/pr-1690/docs/DateInput2.json | 2 +- pr-preview/pr-1690/docs/DateTime.json | 2 +- pr-preview/pr-1690/docs/FocusRegion.json | 2 +- .../pr-1690/docs/FocusRegionManager.json | 2 +- pr-preview/pr-1690/docs/FormPropTypes.json | 2 +- pr-preview/pr-1690/docs/I18nPropTypes.json | 2 +- .../pr-1690/docs/KeyboardFocusRegion.json | 2 +- pr-preview/pr-1690/docs/Locale.json | 2 +- pr-preview/pr-1690/docs/MenuContext.json | 2 +- .../pr-1690/docs/PositionPropTypes.json | 2 +- pr-preview/pr-1690/docs/ProgressCircle.json | 2 +- .../pr-1690/docs/ResponsivePropTypes.json | 2 +- .../pr-1690/docs/ScreenReaderFocusRegion.json | 2 +- pr-preview/pr-1690/docs/SimpleSelect.json | 2 +- .../pr-1690/docs/TextDirectionContext.json | 2 +- pr-preview/pr-1690/docs/ThemeRegistry.json | 2 +- .../pr-1690/docs/ThemeablePropTypes.json | 2 +- pr-preview/pr-1690/docs/ToggleDetails.json | 2 +- pr-preview/pr-1690/docs/Tooltip.json | 2 +- pr-preview/pr-1690/docs/TopNavBarContext.json | 2 +- .../docs/addElementQueryMatchListener.json | 2 +- pr-preview/pr-1690/docs/addEventListener.json | 2 +- .../docs/addMediaQueryMatchListener.json | 2 +- .../docs/addPositionChangeListener.json | 2 +- pr-preview/pr-1690/docs/alpha.json | 2 +- .../docs/calculateElementPosition.json | 2 +- pr-preview/pr-1690/docs/callRenderProp.json | 2 +- pr-preview/pr-1690/docs/camelize.json | 2 +- pr-preview/pr-1690/docs/canUseDOM.json | 2 +- .../pr-1690/docs/capitalizeFirstLetter.json | 2 +- pr-preview/pr-1690/docs/childrenOrValue.json | 2 +- pr-preview/pr-1690/docs/cloneArray.json | 2 +- pr-preview/pr-1690/docs/contains.json | 2 +- .../pr-1690/docs/containsActiveElement.json | 2 +- pr-preview/pr-1690/docs/contrast.json | 2 +- pr-preview/pr-1690/docs/controllable.json | 2 +- pr-preview/pr-1690/docs/conversions.json | 2 +- .../pr-1690/docs/createChainedFunction.json | 2 +- pr-preview/pr-1690/docs/cursor.json | 2 +- pr-preview/pr-1690/docs/darken.json | 2 +- pr-preview/pr-1690/docs/debounce.json | 2 +- pr-preview/pr-1690/docs/decorator.json | 2 +- pr-preview/pr-1690/docs/deepEqual.json | 2 +- pr-preview/pr-1690/docs/deprecated.json | 2 +- pr-preview/pr-1690/docs/element.json | 2 +- .../pr-1690/docs/ensureSingleChild.json | 2 +- pr-preview/pr-1690/docs/experimental.json | 2 +- pr-preview/pr-1690/docs/findDOMNode.json | 2 +- pr-preview/pr-1690/docs/findFocusable.json | 2 +- pr-preview/pr-1690/docs/findTabbable.json | 2 +- pr-preview/pr-1690/docs/getActiveElement.json | 2 +- .../pr-1690/docs/getBoundingClientRect.json | 2 +- pr-preview/pr-1690/docs/getBrowser.json | 2 +- pr-preview/pr-1690/docs/getClassList.json | 2 +- pr-preview/pr-1690/docs/getComputedStyle.json | 2 +- pr-preview/pr-1690/docs/getDisplayName.json | 2 +- pr-preview/pr-1690/docs/getElementType.json | 2 +- pr-preview/pr-1690/docs/getFontSize.json | 2 +- pr-preview/pr-1690/docs/getInteraction.json | 2 +- pr-preview/pr-1690/docs/getOffsetParents.json | 2 +- pr-preview/pr-1690/docs/getScrollParents.json | 2 +- .../pr-1690/docs/getShorthandPropValue.json | 2 +- pr-preview/pr-1690/docs/getTextDirection.json | 2 +- pr-preview/pr-1690/docs/hack.json | 2 +- .../pr-1690/docs/handleMouseOverOut.json | 2 +- .../pr-1690/docs/hasVisibleChildren.json | 2 +- pr-preview/pr-1690/docs/isActiveElement.json | 2 +- .../pr-1690/docs/isDefinedCustomElement.json | 2 +- pr-preview/pr-1690/docs/isValid.json | 2 +- pr-preview/pr-1690/docs/isVisible.json | 2 +- pr-preview/pr-1690/docs/jsonToMediaQuery.json | 2 +- pr-preview/pr-1690/docs/lighten.json | 2 +- pr-preview/pr-1690/docs/makeRequirable.json | 2 +- pr-preview/pr-1690/docs/makeThemeVars.json | 2 +- .../pr-1690/docs/matchComponentTypes.json | 2 +- pr-preview/pr-1690/docs/matchMedia.json | 2 +- pr-preview/pr-1690/docs/mergeDeep.json | 2 +- pr-preview/pr-1690/docs/mirrorPlacement.json | 2 +- pr-preview/pr-1690/docs/mirrorShorthand.json | 2 +- pr-preview/pr-1690/docs/ms.json | 2 +- pr-preview/pr-1690/docs/omitProps.json | 2 +- pr-preview/pr-1690/docs/ownerDocument.json | 2 +- pr-preview/pr-1690/docs/ownerWindow.json | 2 +- pr-preview/pr-1690/docs/parseQuery.json | 2 +- pr-preview/pr-1690/docs/parseUnit.json | 2 +- pr-preview/pr-1690/docs/pascalize.json | 2 +- pr-preview/pr-1690/docs/pickProps.json | 2 +- pr-preview/pr-1690/docs/px.json | 2 +- .../pr-1690/docs/requestAnimationFrame.json | 2 +- pr-preview/pr-1690/docs/scopeTab.json | 2 +- pr-preview/pr-1690/docs/shallowEqual.json | 2 +- .../docs/textDirectionContextConsumer.json | 2 +- .../pr-1690/docs/transformSelection.json | 2 +- pr-preview/pr-1690/docs/uid.json | 2 +- .../pr-1690/docs/windowMessageListener.json | 2 +- pr-preview/pr-1690/docs/withStyle.json | 2 +- pr-preview/pr-1690/docs/within.json | 2 +- pr-preview/pr-1690/docs/xor.json | 2 +- ...c6857af.woff => e7b3f60c4301185b39cc.woff} | Bin 44564 -> 44564 bytes pr-preview/pr-1690/main.js | 76 +++++++++++------- 109 files changed, 148 insertions(+), 132 deletions(-) rename pr-preview/pr-1690/{7566b3be181dcf49fec6.eot => 06a08f6e0c92d8f3d28a.eot} (99%) rename pr-preview/pr-1690/{994f7dea80b34aa4691b.ttf => 32c18c125387e88f9120.ttf} (99%) rename pr-preview/pr-1690/{15a5b3f4610a9b1b3d26.ttf => 34e1595fa073ccba9042.ttf} (99%) rename pr-preview/pr-1690/{81357bec16c11cb058ef.woff => 5aa5decd41057c35b521.woff} (99%) rename pr-preview/pr-1690/{0661ef6853ec82f17418.eot => c8036fe200dd8d7701b9.eot} (99%) rename pr-preview/pr-1690/{49e6e8799cb6ec6857af.woff => e7b3f60c4301185b39cc.woff} (99%) diff --git a/pr-preview/pr-1690/7566b3be181dcf49fec6.eot b/pr-preview/pr-1690/06a08f6e0c92d8f3d28a.eot similarity index 99% rename from pr-preview/pr-1690/7566b3be181dcf49fec6.eot rename to pr-preview/pr-1690/06a08f6e0c92d8f3d28a.eot index 5b406d7bf59e9ba0e1e6aadc2e17eb3481eaec89..d99929273f42da3f91e344788c6eb0cb952eabb8 100644 GIT binary patch delta 60 zcmZp9$kOtVWr7X!(;EMY_V1V<3A0Z&V4N!LU-LAc-{va=H+v%k5Ik0T+zg|eA24oz Jz{t2n4*<6i7773W delta 60 zcmZp9$kOtVWr7X!#J!yp?cXsU`LuDe0pnEZ&b<@k`E9;3aI-fu0KsFC;0PGq{D5)$ J14hOrdI0F)7BK(- diff --git a/pr-preview/pr-1690/994f7dea80b34aa4691b.ttf b/pr-preview/pr-1690/32c18c125387e88f9120.ttf similarity index 99% rename from pr-preview/pr-1690/994f7dea80b34aa4691b.ttf rename to pr-preview/pr-1690/32c18c125387e88f9120.ttf index fff91360ed70c87f733d322869d6beb5b3df5a2e..cd8a1f9a054e765db8427cfe277958aa022d676a 100644 GIT binary patch delta 52 zcmZ2+pJl~;mI;B(kA&GLhD??AuX!5JZ}XLbo4t_%2p%gvZidm#ER5S(7#Wx70Ra3c B5nBKN delta 52 zcmZ2+pJl~;mI;B(M?P(w7&2A5bMM4>ew(ih-0Y1EK=4>3I08mDvoLOFVPssQ2LL6E B5nBKN diff --git a/pr-preview/pr-1690/15a5b3f4610a9b1b3d26.ttf b/pr-preview/pr-1690/34e1595fa073ccba9042.ttf similarity index 99% rename from pr-preview/pr-1690/15a5b3f4610a9b1b3d26.ttf rename to pr-preview/pr-1690/34e1595fa073ccba9042.ttf index dda53b578aeb0b90ccf5997db4f75858543565c8..6f178873cc64ce1f0435c115ee7cd314da5d1d3b 100644 GIT binary patch delta 48 xcmaF!gZa%5<_Uq!&xP40hD?>-Dbo|rZ}XLbo4t_%2p%gvZidmDSr{{Z0|3(I5zGJp delta 48 xcmaF!gZa%5<_Uq!CqHeN7&2A*bF4)?zs*+$ZuUk7Ab2bi908*@voL1-1_1m!5zGJp diff --git a/pr-preview/pr-1690/81357bec16c11cb058ef.woff b/pr-preview/pr-1690/5aa5decd41057c35b521.woff similarity index 99% rename from pr-preview/pr-1690/81357bec16c11cb058ef.woff rename to pr-preview/pr-1690/5aa5decd41057c35b521.woff index 4d211209275c65429f87b9db994645571f42ba48..60b2f5ed6afed88b6fa66ec447ccd04ac315cf00 100644 GIT binary patch delta 62 zcmV-E0KxynpaR680+5XZ=Mx68km`XbEmv~l`E9;3aI-f8MHn6{J#L24|G)hI&fdq~ U4dik#Fo8q?c;OC1v!a5c4W85;wg3PC delta 62 zcmV-E0KxynpaR680+5XZ$?~wVkm`Xb_o5Q<{5D@1xY-+lA`Fj3f+Jw`|1bZ)v-h!g U1GyXwOdwGJF4_y(v!a5c4eqNRYXATM diff --git a/pr-preview/pr-1690/0661ef6853ec82f17418.eot b/pr-preview/pr-1690/c8036fe200dd8d7701b9.eot similarity index 99% rename from pr-preview/pr-1690/0661ef6853ec82f17418.eot rename to pr-preview/pr-1690/c8036fe200dd8d7701b9.eot index f456611893248f06d2139d369f9c148014a46b15..9c4a7d176b5aa9916fffa10efad4522fb15ab9e4 100644 GIT binary patch delta 56 zcmX@}i}}ni<_R{;Ju*8d+J9nxF3dLBgmJ3$PMMx~ew(ih-0Y1EK=4@UaWjnG{Dd*% FHvn`26=VPa delta 56 zcmX@}i}}ni<_R{;7O|fv+J9m``Dw#s6UM31pJOfJ`E9;3aI-fu0KsFC;0PGK`3Ymj FZvdq=6^j4> diff --git a/pr-preview/pr-1690/docs/Calendar.json b/pr-preview/pr-1690/docs/Calendar.json index c53aae9c98..25be7ba39f 100644 --- a/pr-preview/pr-1690/docs/Calendar.json +++ b/pr-preview/pr-1690/docs/Calendar.json @@ -1 +1 @@ -{"description":"\nThe `Calendar` component provides a visual interface for date data.\n\n### Default config\n\nFor ease of use in most situations, the `Calendar` component provides a default\nconfiguration. The default configuration can be overridden by providing props\nto the `Calendar` component.\n\n```js\n---\ntype: example\n---\n\n```\n","displayName":"Calendar","methods":[],"props":{"as":{"type":{"name":"elementType"},"required":false,"description":"The element to render as the `Calendar` root, `span` by default","tsType":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}]},"defaultValue":{"value":"'span'","computed":false}},"children":{"type":{"name":"custom","raw":"ChildrenPropTypes.oneOf([Day])"},"required":false,"description":"children of type `` There should be exactly 42 provided (6\nweeks).","tsType":{"name":"Array","elements":[{"name":"ReactElement","elements":[{"name":"intersection","raw":"CalendarDayOwnProps &\nWithStyleProps &\nOtherHTMLAttributes","elements":[{"name":"signature","type":"object","raw":"{\n /**\n * The rendered representation of the corresponding date.\n */\n children?: Renderable\n /**\n * An ISO 8601 formatted string representing the date corresponding to\n * this ``\n */\n date: string\n /**\n * Accessible label to provide more context for the date to assistive\n * technologies. This should consist of more than just a numerical date value.\n * It should also include the month and the year. Ex. instead of just `1`,\n * provide `1 August 2019`.\n */\n label: string\n /**\n * Is the `` disabled\n */\n interaction?: 'enabled' | 'disabled'\n /**\n * Is the `` selected\n */\n isSelected?: boolean\n /**\n * Is the `` today\n */\n isToday?: boolean\n /**\n * Is the `` located outside the current rendered month\n */\n isOutsideMonth?: boolean\n /**\n * Callback fired on click.\n * @param {Object} event - the click event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onClick?: (\n event: MouseEvent,\n date: { date: string }\n ) => void\n /**\n * Callback fired on key down.\n * @param {Object} event - the key down event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onKeyDown?: (\n event: KeyboardEvent,\n data: { date: string }\n ) => void\n /**\n * A ref function for the underlying DOM element.\n */\n elementRef?: (element: Element | null) => void\n /**\n * the element type to render as\n */\n as?: AsElementType\n}","signature":{"properties":[{"key":"children","value":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}],"required":false},"description":"The rendered representation of the corresponding date."},{"key":"date","value":{"name":"string","required":true},"description":"An ISO 8601 formatted string representing the date corresponding to\nthis ``"},{"key":"label","value":{"name":"string","required":true},"description":"Accessible label to provide more context for the date to assistive\ntechnologies. This should consist of more than just a numerical date value.\nIt should also include the month and the year. Ex. instead of just `1`,\nprovide `1 August 2019`."},{"key":"interaction","value":{"name":"union","raw":"'enabled' | 'disabled'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"}],"required":false},"description":"Is the `` disabled"},{"key":"isSelected","value":{"name":"boolean","required":false},"description":"Is the `` selected"},{"key":"isToday","value":{"name":"boolean","required":false},"description":"Is the `` today"},{"key":"isOutsideMonth","value":{"name":"boolean","required":false},"description":"Is the `` located outside the current rendered month"},{"key":"onClick","value":{"name":"signature","type":"function","raw":"(\n event: MouseEvent,\n date: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"MouseEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"MouseEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"date"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on click.\n@param {Object} event - the click event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"onKeyDown","value":{"name":"signature","type":"function","raw":"(\n event: KeyboardEvent,\n data: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"KeyboardEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"KeyboardEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"data"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on key down.\n@param {Object} event - the key down event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"elementRef","value":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}},"required":false},"description":"A ref function for the underlying DOM element."},{"key":"as","value":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}],"required":false},"description":"the element type to render as"}]}},{"name":"WithStyleProps","elements":[{"name":"signature","type":"object","raw":"{\n color: Colors['contrasts']['grey125125']\n background: Colors['contrasts']['white1010']\n fontSize: Typography['fontSizeMedium']\n padding: Spacing['xxSmall']\n height: Forms['inputHeightSmall']\n minWidth: Forms['inputHeightSmall']\n outsideMonthColor: Colors['contrasts']['grey4570']\n selectedBackground: Colors['contrasts']['green4570']\n selectedColor: Colors['contrasts']['white1010']\n selectedBorderRadius: Border['radiusMedium']\n todayBackground: Colors['contrasts']['blue4570']\n todayColor: Colors['contrasts']['white1010']\n todayBorderRadius: Forms['inputHeightSmall']\n}","signature":{"properties":[{"key":"color","value":{"name":"signature['grey125125']","raw":"Colors['contrasts']['grey125125']","required":true}},{"key":"background","value":{"name":"signature['white1010']","raw":"Colors['contrasts']['white1010']","required":true}},{"key":"fontSize","value":{"name":"union","raw":"Typography['fontSizeMedium']","required":true}},{"key":"padding","value":{"name":"union","raw":"Spacing['xxSmall']","required":true}},{"key":"height","value":{"name":"string","raw":"Forms['inputHeightSmall']","required":true}},{"key":"minWidth","value":{"name":"string","raw":"Forms['inputHeightSmall']","required":true}},{"key":"outsideMonthColor","value":{"name":"signature['grey4570']","raw":"Colors['contrasts']['grey4570']","required":true}},{"key":"selectedBackground","value":{"name":"signature['green4570']","raw":"Colors['contrasts']['green4570']","required":true}},{"key":"selectedColor","value":{"name":"signature['white1010']","raw":"Colors['contrasts']['white1010']","required":true}},{"key":"selectedBorderRadius","value":{"name":"union","raw":"Border['radiusMedium']","required":true}},{"key":"todayBackground","value":{"name":"signature['blue4570']","raw":"Colors['contrasts']['blue4570']","required":true}},{"key":"todayColor","value":{"name":"signature['white1010']","raw":"Colors['contrasts']['white1010']","required":true}},{"key":"todayBorderRadius","value":{"name":"string","raw":"Forms['inputHeightSmall']","required":true}}]}},{"name":"ComponentStyle","elements":[{"name":"union","raw":"'calendarDay' | 'day'","elements":[{"name":"literal","value":"'calendarDay'"},{"name":"literal","value":"'day'"}]}],"raw":"ComponentStyle<'calendarDay' | 'day'>"}],"raw":"WithStyleProps"},{"name":"intersection","raw":"Omit & { dir?: 'ltr' | 'rtl' }","elements":[{"name":"Omit","elements":[{"name":"unknown"},{"name":"union","raw":"keyof Props | 'dir'","elements":[{"name":"signature","type":"object","raw":"{\n /**\n * The rendered representation of the corresponding date.\n */\n children?: Renderable\n /**\n * An ISO 8601 formatted string representing the date corresponding to\n * this ``\n */\n date: string\n /**\n * Accessible label to provide more context for the date to assistive\n * technologies. This should consist of more than just a numerical date value.\n * It should also include the month and the year. Ex. instead of just `1`,\n * provide `1 August 2019`.\n */\n label: string\n /**\n * Is the `` disabled\n */\n interaction?: 'enabled' | 'disabled'\n /**\n * Is the `` selected\n */\n isSelected?: boolean\n /**\n * Is the `` today\n */\n isToday?: boolean\n /**\n * Is the `` located outside the current rendered month\n */\n isOutsideMonth?: boolean\n /**\n * Callback fired on click.\n * @param {Object} event - the click event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onClick?: (\n event: MouseEvent,\n date: { date: string }\n ) => void\n /**\n * Callback fired on key down.\n * @param {Object} event - the key down event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onKeyDown?: (\n event: KeyboardEvent,\n data: { date: string }\n ) => void\n /**\n * A ref function for the underlying DOM element.\n */\n elementRef?: (element: Element | null) => void\n /**\n * the element type to render as\n */\n as?: AsElementType\n}","signature":{"properties":[{"key":"children","value":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}],"required":false},"description":"The rendered representation of the corresponding date."},{"key":"date","value":{"name":"string","required":true},"description":"An ISO 8601 formatted string representing the date corresponding to\nthis ``"},{"key":"label","value":{"name":"string","required":true},"description":"Accessible label to provide more context for the date to assistive\ntechnologies. This should consist of more than just a numerical date value.\nIt should also include the month and the year. Ex. instead of just `1`,\nprovide `1 August 2019`."},{"key":"interaction","value":{"name":"union","raw":"'enabled' | 'disabled'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"}],"required":false},"description":"Is the `` disabled"},{"key":"isSelected","value":{"name":"boolean","required":false},"description":"Is the `` selected"},{"key":"isToday","value":{"name":"boolean","required":false},"description":"Is the `` today"},{"key":"isOutsideMonth","value":{"name":"boolean","required":false},"description":"Is the `` located outside the current rendered month"},{"key":"onClick","value":{"name":"signature","type":"function","raw":"(\n event: MouseEvent,\n date: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"MouseEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"MouseEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"date"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on click.\n@param {Object} event - the click event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"onKeyDown","value":{"name":"signature","type":"function","raw":"(\n event: KeyboardEvent,\n data: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"KeyboardEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"KeyboardEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"data"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on key down.\n@param {Object} event - the key down event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"elementRef","value":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}},"required":false},"description":"A ref function for the underlying DOM element."},{"key":"as","value":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}],"required":false},"description":"the element type to render as"}]}},{"name":"literal","value":"'dir'"}]}],"raw":"Omit"},{"name":"signature","type":"object","raw":"{ dir?: 'ltr' | 'rtl' }","signature":{"properties":[{"key":"dir","value":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}],"required":false}}]}}]}]}],"raw":"ReactElement"}],"raw":"ReactElement[]"}},"currentDate":{"type":{"name":"string"},"required":false,"description":"ISO date string for the current date if necessary. Defaults to the current\ndate in the user's timezone.","tsType":{"name":"string"}},"disabledDates":{"type":{"name":"union","value":[{"name":"array"},{"name":"func"}]},"required":false,"description":"","tsType":{"name":"union","raw":"string[] | ((isoDateToCheck: string) => boolean)","elements":[{"name":"Array","elements":[{"name":"string"}],"raw":"string[]"},{"name":"unknown"}]}},"locale":{"type":{"name":"string"},"required":false,"description":"A standard language identifier.\n\nSee [Moment.js](https://momentjs.com/timezone/docs/#/using-timezones/parsing-in-zone/) for\nmore details.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's locale will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"onDateSelected":{"type":{"name":"func"},"required":false,"description":"Callback fired when a day has been selected.","tsType":{"name":"signature","type":"function","raw":"(\n dateString: string,\n momentDate: Moment,\n e: React.MouseEvent\n) => void","signature":{"arguments":[{"type":{"name":"string"},"name":"dateString"},{"type":{"name":"Moment"},"name":"momentDate"},{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"}],"return":{"name":"void"}}}},"onRequestRenderNextMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired when the next month button is clicked in the navigation\nheader, requesting to render the next month.","tsType":{"name":"signature","type":"function","raw":"(\n e: React.MouseEvent,\n requestedMonth: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"},{"type":{"name":"string"},"name":"requestedMonth"}],"return":{"name":"void"}}}},"onRequestRenderPrevMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired when the previous month button is clicked in the navigation\nheader, requesting to render the previous month.","tsType":{"name":"signature","type":"function","raw":"(\n e: React.MouseEvent,\n requestedMonth: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"},{"type":{"name":"string"},"name":"requestedMonth"}],"return":{"name":"void"}}}},"renderNavigationLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to render in the navigation header. The recommendation is to include\nthe name of the current rendered month along with the year.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderNextMonthButton":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"A button to render in the navigation header. The recommendation is to\ncompose it with the [IconButton](#IconButton) component by setting the `size`\nprop to `small`, `withBorder` and `withBackground` to `false`, and setting\n`renderIcon` to [IconArrowOpenEnd](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderPrevMonthButton":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"A button to render in the navigation header. The recommendation is to\ncompose it with the [IconButton](#Button) component by setting the `size`\nprop to `small`, `withBorder` and `withBackground` to `false`, and setting\n`renderIcon` to [IconArrowOpenStart](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderWeekdayLabels":{"type":{"name":"arrayOf","value":{"name":"union","value":[{"name":"node"},{"name":"func"}]}},"required":false,"description":"An array of labels containing the name of each day of the week. The visible\nportion of the label should be abbreviated (no longer than three characters).\nNote that screen readers will read this content preceding each date as the\n`` is navigated. Consider using\n[AccessibleContent](#AccessibleContent) with the `alt` prop containing the\nfull day name for assistive technologies and the children containing the\nabbreviation. ex. `[Sun, ...]`","tsType":{"name":"Array","elements":[{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}],"raw":"Renderable[]"}},"role":{"type":{"name":"enum","value":[{"value":"'table'","computed":false},{"value":"'listbox'","computed":false}]},"required":false,"description":"The role of the underlying table. This can be set to 'listbox' when\nassistive technologies need to read the `` children as a list.","tsType":{"name":"union","raw":"'table' | 'listbox'","elements":[{"name":"literal","value":"'table'"},{"name":"literal","value":"'listbox'"}]},"defaultValue":{"value":"'table'","computed":false}},"selectedDate":{"type":{"name":"string"},"required":false,"description":"ISO date string for the selected date. It needs onDateSelected to be specified too.","tsType":{"name":"string"}},"timezone":{"type":{"name":"string"},"required":false,"description":"A timezone identifier in the format: *Area/Location*\n\nSee [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list\nof possible options.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's timezone will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"visibleMonth":{"type":{"name":"string"},"required":false,"description":"Visible month for the rendered calendar. Formatted as an ISO date string.","tsType":{"name":"string"}},"withYearPicker":{"type":{"name":"object"},"required":false,"description":"If set, years can be picked from a dropdown.\nIt accepts an object.\nscreenReaderLabel: string // e.g.: i18n(\"pick a year\")\n\nonRequestYearChange?:(e: React.MouseEvent,requestedYear: number): void // if set, on year change, only this will be called and no internal change will take place\n\nstartYear: number // e.g.: 2001, sets the start year of the selectable list\n\nendYear: number // e.g.: 2030, sets the end year of the selectable list","tsType":{"name":"signature","type":"object","raw":"{\n screenReaderLabel: string\n onRequestYearChange?: (e: any, requestedYear: number) => void\n startYear: number\n endYear: number\n}","signature":{"properties":[{"key":"screenReaderLabel","value":{"name":"string","required":true}},{"key":"onRequestYearChange","value":{"name":"signature","type":"function","raw":"(e: any, requestedYear: number) => void","signature":{"arguments":[{"type":{"name":"any"},"name":"e"},{"type":{"name":"number"},"name":"requestedYear"}],"return":{"name":"void"}},"required":false}},{"key":"startYear","value":{"name":"number","required":true}},{"key":"endYear","value":{"name":"number","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-calendar/src/Calendar/index.tsx","extension":".tsx","srcPath":"packages/ui-calendar/src/Calendar/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-calendar/src/Calendar/index.tsx","packageName":"@instructure/ui-calendar","requirePath":"@instructure/ui-calendar/lib/Calendar/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-calendar/src/Calendar/index.tsx').default","esPath":"@instructure/ui-calendar/es/Calendar/index","themePath":"packages/ui-calendar/src/Calendar/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-calendar/src/Calendar/theme.ts","id":"Calendar","title":"Calendar"} \ No newline at end of file +{"description":"\nThe `Calendar` component provides a visual interface for date data.\n\n### Default config\n\nFor ease of use in most situations, the `Calendar` component provides a default\nconfiguration. The default configuration can be overridden by providing props\nto the `Calendar` component.\n\n```js\n---\ntype: example\n---\n\n```\n\n### Default config with additional props\n\n- ```js\n class Example extends React.Component {\n state = {\n selectedDate: '',\n visibleMonth: '2025-05'\n }\n\n render = () => (\n \n this.setState({ visibleMonth: requestedMonth })\n }\n onRequestRenderPrevMonth={(_e, requestedMonth) =>\n this.setState({ visibleMonth: requestedMonth })\n }\n onDateSelected={(date) => {\n this.setState({ selectedDate: date })\n }}\n />\n )\n }\n render()\n ```\n\n- ```js\n const Example = () => {\n const [selectedDate, setSelectedDate] = useState('')\n const [visibleMonth, setVisibleMonth] = useState('2025-05')\n\n return (\n \n setVisibleMonth(requestedMonth)\n }\n onRequestRenderPrevMonth={(_e, requestedMonth) =>\n setVisibleMonth(requestedMonth)\n }\n onDateSelected={(date) => {\n setSelectedDate(date)\n }}\n />\n )\n }\n render()\n ```\n\n### With year picker\n\n- ```js\n class Example extends React.Component {\n state = {\n selectedDate: '',\n visibleMonth: '2024-02'\n }\n\n render = () => (\n \n this.setState({ visibleMonth: requestedMonth })\n }\n onRequestRenderPrevMonth={(_e, requestedMonth) =>\n this.setState({ visibleMonth: requestedMonth })\n }\n onDateSelected={(date) => {\n this.setState({ selectedDate: date })\n }}\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1999,\n endYear: 2024,\n maxHeight: '200px'\n }}\n />\n )\n }\n render()\n ```\n\n- ```js\n const Example = () => {\n const [selectedDate, setSelectedDate] = useState('')\n const [visibleMonth, setVisibleMonth] = useState('2024-02')\n\n return (\n \n setVisibleMonth(requestedMonth)\n }\n onRequestRenderPrevMonth={(_e, requestedMonth) =>\n setVisibleMonth(requestedMonth)\n }\n onDateSelected={(date) => {\n setSelectedDate(date)\n }}\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1999,\n endYear: 2024,\n maxHeight: '200px'\n }}\n />\n )\n }\n render()\n ```\n\n### Composing a Calendar in your Application\n\nBy design, the `Calendar` component does not dictate which date libraries or\nformats you use in your application. The following example demonstrates how a\nbasic `Calendar` might be created using utilities from\n[Moment.js](https://momentjs.com/docs/#/parsing/).\n\n- ```js\n class Example extends React.Component {\n state = {\n todayDate: parseDate('2019-08-16').toISOString(),\n renderedDate: parseDate('2019-08-02').toISOString()\n }\n\n generateMonth = () => {\n const date = parseDate(this.state.renderedDate)\n .startOf('month')\n .startOf('week')\n\n return Array.apply(null, Array(Calendar.DAY_COUNT)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'days')\n return currentDate\n })\n }\n\n renderWeekdayLabels = () => {\n const date = parseDate(this.state.renderedDate).startOf('week')\n\n return Array.apply(null, Array(7)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'day')\n\n return (\n \n {currentDate.format('dd')}\n \n )\n })\n }\n\n handleRenderNextMonth = (event) => {\n this.modifyRenderedMonth(1)\n }\n\n handleRenderPrevMonth = (event) => {\n this.modifyRenderedMonth(-1)\n }\n\n modifyRenderedMonth = (step) => {\n this.setState(({ renderedDate }) => {\n const date = parseDate(renderedDate)\n date.add(step, 'month')\n return { renderedDate: date.toISOString() }\n })\n }\n\n renderDay(date) {\n const { renderedDate, todayDate } = this.state\n\n return (\n \n {date.format('D')}\n \n )\n }\n\n render() {\n const date = parseDate(this.state.renderedDate)\n\n const buttonProps = (type = 'prev') => ({\n size: 'small',\n withBackground: false,\n withBorder: false,\n renderIcon:\n type === 'prev' ? (\n \n ) : (\n \n ),\n screenReaderLabel: type === 'prev' ? 'Previous month' : 'Next month'\n })\n\n return (\n }\n renderNextMonthButton={}\n renderNavigationLabel={\n \n

{date.format('MMMM')}
\n
{date.format('YYYY')}
\n \n }\n renderWeekdayLabels={this.renderWeekdayLabels()}\n onRequestRenderNextMonth={this.handleRenderNextMonth}\n onRequestRenderPrevMonth={this.handleRenderPrevMonth}\n >\n {this.generateMonth().map((date) => this.renderDay(date))}\n \n )\n }\n }\n\n const locale = 'en-us'\n const timezone = 'America/Denver'\n\n const parseDate = (dateStr) => {\n return moment.tz(dateStr, [moment.ISO_8601], locale, timezone)\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [renderedDate, setRenderedDate] = useState(\n parseDate('2019-08-02').toISOString()\n )\n\n const todayDate = parseDate('2019-08-16').toISOString()\n const generateMonth = () => {\n const date = parseDate(renderedDate).startOf('month').startOf('week')\n\n return Array.apply(null, Array(Calendar.DAY_COUNT)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'days')\n return currentDate\n })\n }\n\n const renderWeekdayLabels = () => {\n const date = parseDate(renderedDate).startOf('week')\n\n return Array.apply(null, Array(7)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'day')\n\n return (\n \n {currentDate.format('dd')}\n \n )\n })\n }\n\n const handleRenderNextMonth = (event) => {\n modifyRenderedMonth(1)\n }\n\n const handleRenderPrevMonth = (event) => {\n modifyRenderedMonth(-1)\n }\n\n const modifyRenderedMonth = (step) => {\n const date = parseDate(renderedDate)\n date.add(step, 'month')\n setRenderedDate(date.toISOString())\n }\n\n const renderDay = (date) => {\n return (\n \n {date.format('D')}\n \n )\n }\n\n const date = parseDate(renderedDate)\n\n const buttonProps = (type = 'prev') => ({\n size: 'small',\n withBackground: false,\n withBorder: false,\n renderIcon:\n type === 'prev' ? (\n \n ) : (\n \n ),\n screenReaderLabel: type === 'prev' ? 'Previous month' : 'Next month'\n })\n\n return (\n }\n renderNextMonthButton={}\n renderNavigationLabel={\n \n
{date.format('MMMM')}
\n
{date.format('YYYY')}
\n \n }\n renderWeekdayLabels={renderWeekdayLabels()}\n onRequestRenderNextMonth={handleRenderNextMonth}\n onRequestRenderPrevMonth={handleRenderPrevMonth}\n >\n {generateMonth().map((date) => renderDay(date))}\n \n )\n }\n\n const locale = 'en-us'\n const timezone = 'America/Denver'\n\n const parseDate = (dateStr) => {\n return moment.tz(dateStr, [moment.ISO_8601], locale, timezone)\n }\n\n render()\n ```\n\n#### Some dates to keep track of\n\n- `todayDate` - the date that represents today\n- `renderedDate` - the date that the user is viewing as they navigate the `Calendar`\n\n#### Generating a month\n\nWe generate a month based on the `renderedDate` value. The `Calendar` always\ndisplays 6 weeks or 42 days (42 is defined as a constant `Calendar.DAY_COUNT`),\nso we pad our month values with days from the previous and next month if\nnecessary. The complete implementation can be seen in the `generateMonth` function\nin our example.\n\n#### Rendering days\n\nUsing the month data, we can now map it to children of type `Calendar.Day`.\nAs we render each day, if it is outside the current month we can set the\n`isOutsideMonth` prop. We can also set the `isToday` prop if it is the current\ndate. For accessibility, it is recommended that you provide more information to\neach `Calendar.Day` using the label prop. This label will help screen readers to\nhave important context as the `Calendar` is navigated. It should include the day,\nmonth, and the year (Ex. instead of `1` we would provide `1 August 2019`).\n\n#### Rendering weekday labels\n\n`Calendar` requires you to provide an array of 7 labels that correspond to each\nday of the week via the `renderWeekdayLabels` prop. The visible portion of the\nlabel should be abbreviated (no longer than three characters). Note that screen\nreaders will read this content preceding each date as the `Calendar` is navigated.\nConsider using [AccessibleContent](#AccessibleContent) with the `alt` prop\ncontaining the full day name for assistive technologies and the children containing\nthe abbreviation. ex. `[Sun, ...]`\n\n#### Rendering next and previous month buttons\n\nThe `renderNextMonthButton` and `renderPrevMonthButton` can be supplied using the\n[IconButton](#IconButton) component with the `size` prop set to\n`small`, the `withBackground` and `withBorder` props both set to `false`, and the `renderIcon` prop set to [IconArrowOpenStart](#iconography) or\n[IconArrowOpenEnd](#iconography).\n","displayName":"Calendar","methods":[],"props":{"as":{"type":{"name":"elementType"},"required":false,"description":"The element to render as the `Calendar` root, `span` by default","tsType":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}]},"defaultValue":{"value":"'span'","computed":false}},"children":{"type":{"name":"custom","raw":"ChildrenPropTypes.oneOf([Day])"},"required":false,"description":"children of type `` There should be exactly 42 provided (6\nweeks).","tsType":{"name":"Array","elements":[{"name":"ReactElement","elements":[{"name":"intersection","raw":"CalendarDayOwnProps &\nWithStyleProps &\nOtherHTMLAttributes","elements":[{"name":"signature","type":"object","raw":"{\n /**\n * The rendered representation of the corresponding date.\n */\n children?: Renderable\n /**\n * An ISO 8601 formatted string representing the date corresponding to\n * this ``\n */\n date: string\n /**\n * Accessible label to provide more context for the date to assistive\n * technologies. This should consist of more than just a numerical date value.\n * It should also include the month and the year. Ex. instead of just `1`,\n * provide `1 August 2019`.\n */\n label: string\n /**\n * Is the `` disabled\n */\n interaction?: 'enabled' | 'disabled'\n /**\n * Is the `` selected\n */\n isSelected?: boolean\n /**\n * Is the `` today\n */\n isToday?: boolean\n /**\n * Is the `` located outside the current rendered month\n */\n isOutsideMonth?: boolean\n /**\n * Callback fired on click.\n * @param {Object} event - the click event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onClick?: (\n event: MouseEvent,\n date: { date: string }\n ) => void\n /**\n * Callback fired on key down.\n * @param {Object} event - the key down event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onKeyDown?: (\n event: KeyboardEvent,\n data: { date: string }\n ) => void\n /**\n * A ref function for the underlying DOM element.\n */\n elementRef?: (element: Element | null) => void\n /**\n * the element type to render as\n */\n as?: AsElementType\n}","signature":{"properties":[{"key":"children","value":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}],"required":false},"description":"The rendered representation of the corresponding date."},{"key":"date","value":{"name":"string","required":true},"description":"An ISO 8601 formatted string representing the date corresponding to\nthis ``"},{"key":"label","value":{"name":"string","required":true},"description":"Accessible label to provide more context for the date to assistive\ntechnologies. This should consist of more than just a numerical date value.\nIt should also include the month and the year. Ex. instead of just `1`,\nprovide `1 August 2019`."},{"key":"interaction","value":{"name":"union","raw":"'enabled' | 'disabled'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"}],"required":false},"description":"Is the `` disabled"},{"key":"isSelected","value":{"name":"boolean","required":false},"description":"Is the `` selected"},{"key":"isToday","value":{"name":"boolean","required":false},"description":"Is the `` today"},{"key":"isOutsideMonth","value":{"name":"boolean","required":false},"description":"Is the `` located outside the current rendered month"},{"key":"onClick","value":{"name":"signature","type":"function","raw":"(\n event: MouseEvent,\n date: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"MouseEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"MouseEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"date"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on click.\n@param {Object} event - the click event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"onKeyDown","value":{"name":"signature","type":"function","raw":"(\n event: KeyboardEvent,\n data: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"KeyboardEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"KeyboardEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"data"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on key down.\n@param {Object} event - the key down event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"elementRef","value":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}},"required":false},"description":"A ref function for the underlying DOM element."},{"key":"as","value":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}],"required":false},"description":"the element type to render as"}]}},{"name":"WithStyleProps","elements":[{"name":"signature","type":"object","raw":"{\n color: Colors['contrasts']['grey125125']\n background: Colors['contrasts']['white1010']\n fontSize: Typography['fontSizeMedium']\n padding: Spacing['xxSmall']\n height: Forms['inputHeightSmall']\n minWidth: Forms['inputHeightSmall']\n outsideMonthColor: Colors['contrasts']['grey4570']\n selectedBackground: Colors['contrasts']['green4570']\n selectedColor: Colors['contrasts']['white1010']\n selectedBorderRadius: Border['radiusMedium']\n todayBackground: Colors['contrasts']['blue4570']\n todayColor: Colors['contrasts']['white1010']\n todayBorderRadius: Forms['inputHeightSmall']\n}","signature":{"properties":[{"key":"color","value":{"name":"signature['grey125125']","raw":"Colors['contrasts']['grey125125']","required":true}},{"key":"background","value":{"name":"signature['white1010']","raw":"Colors['contrasts']['white1010']","required":true}},{"key":"fontSize","value":{"name":"union","raw":"Typography['fontSizeMedium']","required":true}},{"key":"padding","value":{"name":"union","raw":"Spacing['xxSmall']","required":true}},{"key":"height","value":{"name":"string","raw":"Forms['inputHeightSmall']","required":true}},{"key":"minWidth","value":{"name":"string","raw":"Forms['inputHeightSmall']","required":true}},{"key":"outsideMonthColor","value":{"name":"signature['grey4570']","raw":"Colors['contrasts']['grey4570']","required":true}},{"key":"selectedBackground","value":{"name":"signature['green4570']","raw":"Colors['contrasts']['green4570']","required":true}},{"key":"selectedColor","value":{"name":"signature['white1010']","raw":"Colors['contrasts']['white1010']","required":true}},{"key":"selectedBorderRadius","value":{"name":"union","raw":"Border['radiusMedium']","required":true}},{"key":"todayBackground","value":{"name":"signature['blue4570']","raw":"Colors['contrasts']['blue4570']","required":true}},{"key":"todayColor","value":{"name":"signature['white1010']","raw":"Colors['contrasts']['white1010']","required":true}},{"key":"todayBorderRadius","value":{"name":"string","raw":"Forms['inputHeightSmall']","required":true}}]}},{"name":"ComponentStyle","elements":[{"name":"union","raw":"'calendarDay' | 'day'","elements":[{"name":"literal","value":"'calendarDay'"},{"name":"literal","value":"'day'"}]}],"raw":"ComponentStyle<'calendarDay' | 'day'>"}],"raw":"WithStyleProps"},{"name":"intersection","raw":"Omit & { dir?: 'ltr' | 'rtl' }","elements":[{"name":"Omit","elements":[{"name":"unknown"},{"name":"union","raw":"keyof Props | 'dir'","elements":[{"name":"signature","type":"object","raw":"{\n /**\n * The rendered representation of the corresponding date.\n */\n children?: Renderable\n /**\n * An ISO 8601 formatted string representing the date corresponding to\n * this ``\n */\n date: string\n /**\n * Accessible label to provide more context for the date to assistive\n * technologies. This should consist of more than just a numerical date value.\n * It should also include the month and the year. Ex. instead of just `1`,\n * provide `1 August 2019`.\n */\n label: string\n /**\n * Is the `` disabled\n */\n interaction?: 'enabled' | 'disabled'\n /**\n * Is the `` selected\n */\n isSelected?: boolean\n /**\n * Is the `` today\n */\n isToday?: boolean\n /**\n * Is the `` located outside the current rendered month\n */\n isOutsideMonth?: boolean\n /**\n * Callback fired on click.\n * @param {Object} event - the click event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onClick?: (\n event: MouseEvent,\n date: { date: string }\n ) => void\n /**\n * Callback fired on key down.\n * @param {Object} event - the key down event\n * @param {Object} data - additional data\n * @param data.date - the date of the corresponding ``\n */\n onKeyDown?: (\n event: KeyboardEvent,\n data: { date: string }\n ) => void\n /**\n * A ref function for the underlying DOM element.\n */\n elementRef?: (element: Element | null) => void\n /**\n * the element type to render as\n */\n as?: AsElementType\n}","signature":{"properties":[{"key":"children","value":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}],"required":false},"description":"The rendered representation of the corresponding date."},{"key":"date","value":{"name":"string","required":true},"description":"An ISO 8601 formatted string representing the date corresponding to\nthis ``"},{"key":"label","value":{"name":"string","required":true},"description":"Accessible label to provide more context for the date to assistive\ntechnologies. This should consist of more than just a numerical date value.\nIt should also include the month and the year. Ex. instead of just `1`,\nprovide `1 August 2019`."},{"key":"interaction","value":{"name":"union","raw":"'enabled' | 'disabled'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"}],"required":false},"description":"Is the `` disabled"},{"key":"isSelected","value":{"name":"boolean","required":false},"description":"Is the `` selected"},{"key":"isToday","value":{"name":"boolean","required":false},"description":"Is the `` today"},{"key":"isOutsideMonth","value":{"name":"boolean","required":false},"description":"Is the `` located outside the current rendered month"},{"key":"onClick","value":{"name":"signature","type":"function","raw":"(\n event: MouseEvent,\n date: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"MouseEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"MouseEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"date"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on click.\n@param {Object} event - the click event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"onKeyDown","value":{"name":"signature","type":"function","raw":"(\n event: KeyboardEvent,\n data: { date: string }\n) => void","signature":{"arguments":[{"type":{"name":"KeyboardEvent","elements":[{"name":"intersection","raw":"ViewProps & Element","elements":[{"name":"ViewProps"},{"name":"Element"}]}],"raw":"KeyboardEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ date: string }","signature":{"properties":[{"key":"date","value":{"name":"string","required":true}}]}},"name":"data"}],"return":{"name":"void"}},"required":false},"description":"Callback fired on key down.\n@param {Object} event - the key down event\n@param {Object} data - additional data\n@param data.date - the date of the corresponding ``"},{"key":"elementRef","value":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}},"required":false},"description":"A ref function for the underlying DOM element."},{"key":"as","value":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}],"required":false},"description":"the element type to render as"}]}},{"name":"literal","value":"'dir'"}]}],"raw":"Omit"},{"name":"signature","type":"object","raw":"{ dir?: 'ltr' | 'rtl' }","signature":{"properties":[{"key":"dir","value":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}],"required":false}}]}}]}]}],"raw":"ReactElement"}],"raw":"ReactElement[]"}},"currentDate":{"type":{"name":"string"},"required":false,"description":"ISO date string for the current date if necessary. Defaults to the current\ndate in the user's timezone.","tsType":{"name":"string"}},"disabledDates":{"type":{"name":"union","value":[{"name":"array"},{"name":"func"}]},"required":false,"description":"","tsType":{"name":"union","raw":"string[] | ((isoDateToCheck: string) => boolean)","elements":[{"name":"Array","elements":[{"name":"string"}],"raw":"string[]"},{"name":"unknown"}]}},"locale":{"type":{"name":"string"},"required":false,"description":"A standard language identifier.\n\nSee [Moment.js](https://momentjs.com/timezone/docs/#/using-timezones/parsing-in-zone/) for\nmore details.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's locale will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"onDateSelected":{"type":{"name":"func"},"required":false,"description":"Callback fired when a day has been selected.","tsType":{"name":"signature","type":"function","raw":"(\n dateString: string,\n momentDate: Moment,\n e: React.MouseEvent\n) => void","signature":{"arguments":[{"type":{"name":"string"},"name":"dateString"},{"type":{"name":"Moment"},"name":"momentDate"},{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"}],"return":{"name":"void"}}}},"onRequestRenderNextMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired when the next month button is clicked in the navigation\nheader, requesting to render the next month.","tsType":{"name":"signature","type":"function","raw":"(\n e: React.MouseEvent,\n requestedMonth: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"},{"type":{"name":"string"},"name":"requestedMonth"}],"return":{"name":"void"}}}},"onRequestRenderPrevMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired when the previous month button is clicked in the navigation\nheader, requesting to render the previous month.","tsType":{"name":"signature","type":"function","raw":"(\n e: React.MouseEvent,\n requestedMonth: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"},{"type":{"name":"string"},"name":"requestedMonth"}],"return":{"name":"void"}}}},"renderNavigationLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to render in the navigation header. The recommendation is to include\nthe name of the current rendered month along with the year.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderNextMonthButton":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"A button to render in the navigation header. The recommendation is to\ncompose it with the [IconButton](#IconButton) component by setting the `size`\nprop to `small`, `withBorder` and `withBackground` to `false`, and setting\n`renderIcon` to [IconArrowOpenEnd](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderPrevMonthButton":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"A button to render in the navigation header. The recommendation is to\ncompose it with the [IconButton](#Button) component by setting the `size`\nprop to `small`, `withBorder` and `withBackground` to `false`, and setting\n`renderIcon` to [IconArrowOpenStart](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderWeekdayLabels":{"type":{"name":"arrayOf","value":{"name":"union","value":[{"name":"node"},{"name":"func"}]}},"required":false,"description":"An array of labels containing the name of each day of the week. The visible\nportion of the label should be abbreviated (no longer than three characters).\nNote that screen readers will read this content preceding each date as the\n`` is navigated. Consider using\n[AccessibleContent](#AccessibleContent) with the `alt` prop containing the\nfull day name for assistive technologies and the children containing the\nabbreviation. ex. `[Sun, ...]`","tsType":{"name":"Array","elements":[{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}],"raw":"Renderable[]"}},"role":{"type":{"name":"enum","value":[{"value":"'table'","computed":false},{"value":"'listbox'","computed":false}]},"required":false,"description":"The role of the underlying table. This can be set to 'listbox' when\nassistive technologies need to read the `` children as a list.","tsType":{"name":"union","raw":"'table' | 'listbox'","elements":[{"name":"literal","value":"'table'"},{"name":"literal","value":"'listbox'"}]},"defaultValue":{"value":"'table'","computed":false}},"selectedDate":{"type":{"name":"string"},"required":false,"description":"ISO date string for the selected date. It needs onDateSelected to be specified too.","tsType":{"name":"string"}},"timezone":{"type":{"name":"string"},"required":false,"description":"A timezone identifier in the format: *Area/Location*\n\nSee [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list\nof possible options.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's timezone will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"visibleMonth":{"type":{"name":"string"},"required":false,"description":"Visible month for the rendered calendar. Formatted as an ISO date string.","tsType":{"name":"string"}},"withYearPicker":{"type":{"name":"object"},"required":false,"description":"If set, years can be picked from a dropdown.\nIt accepts an object.\nscreenReaderLabel: string // e.g.: i18n(\"pick a year\")\n\nonRequestYearChange?:(e: React.MouseEvent,requestedYear: number): void // if set, on year change, only this will be called and no internal change will take place\n\nstartYear: number // e.g.: 2001, sets the start year of the selectable list\n\nendYear: number // e.g.: 2030, sets the end year of the selectable list","tsType":{"name":"signature","type":"object","raw":"{\n screenReaderLabel: string\n onRequestYearChange?: (e: any, requestedYear: number) => void\n startYear: number\n endYear: number\n}","signature":{"properties":[{"key":"screenReaderLabel","value":{"name":"string","required":true}},{"key":"onRequestYearChange","value":{"name":"signature","type":"function","raw":"(e: any, requestedYear: number) => void","signature":{"arguments":[{"type":{"name":"any"},"name":"e"},{"type":{"name":"number"},"name":"requestedYear"}],"return":{"name":"void"}},"required":false}},{"key":"startYear","value":{"name":"number","required":true}},{"key":"endYear","value":{"name":"number","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-calendar/src/Calendar/index.tsx","extension":".tsx","srcPath":"packages/ui-calendar/src/Calendar/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-calendar/src/Calendar/index.tsx","packageName":"@instructure/ui-calendar","requirePath":"@instructure/ui-calendar/lib/Calendar/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-calendar/src/Calendar/index.tsx').default","esPath":"@instructure/ui-calendar/es/Calendar/index","themePath":"packages/ui-calendar/src/Calendar/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-calendar/src/Calendar/theme.ts","id":"Calendar","title":"Calendar"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/Checkbox.json b/pr-preview/pr-1690/docs/Checkbox.json index ec7a214903..082dbc3948 100644 --- a/pr-preview/pr-1690/docs/Checkbox.json +++ b/pr-preview/pr-1690/docs/Checkbox.json @@ -1 +1 @@ -{"description":"\nBy default, the Checkbox component is a custom styled HTML checkbox. To default the checkbox to checked,\nset the `defaultChecked` prop.\n\nAdjust the size of the checkbox and label text via the `size` prop. The default size is\n`medium`.\n\n```js\n---\ntype: example\n---\n\n```\n\nThe default Checkbox in its disabled state:\n\n```js\n---\ntype: example\n---\nCheckbox examples}\n>\n \n \n\n```\n\nThe `indeterminate` property triggers a visual state that handles\nsituations where \"child\" Checkboxes are neither all checked nor all\nunchecked. Note the use of `aria-labelledby` to make the relationship\nbetween the parent and child Checkboxes clear to screenreader users.\n\n_Note: the `toggle` variant does not support the `indeterminate`\nproperty._\n\n- ```js\n class Example extends React.Component {\n constructor(props) {\n super(props)\n\n this.state = {\n value: ['his111', 'eng203']\n }\n }\n\n updateValue(value) {\n const index = this.state.value.indexOf(value)\n\n if (index === -1) {\n this.setState({ value: [...this.state.value, value] })\n } else {\n this.setState((prevState) => ({\n value: [\n ...prevState.value.slice(0, index),\n ...prevState.value.slice(index + 1)\n ]\n }))\n }\n }\n\n render() {\n return (\n \n Courses to edit\n \n }\n rowSpacing=\"small\"\n >\n Select all courses}\n value=\"all\"\n onChange={() =>\n this.setState({\n value:\n this.state.value.length === 3\n ? []\n : ['eng203', 'sci101', 'his111']\n })\n }\n checked={this.state.value.length === 3}\n indeterminate={\n this.state.value.length > 0 && this.state.value.length < 3\n }\n />\n \n English 203}\n value=\"eng203\"\n name=\"courses\"\n onChange={(event) => {\n this.updateValue(event.target.value)\n }}\n checked={this.state.value.indexOf('eng203') !== -1}\n />\n \n \n Science 101}\n value=\"sci101\"\n name=\"courses\"\n onChange={(event) => {\n this.updateValue(event.target.value)\n }}\n checked={this.state.value.indexOf('sci101') !== -1}\n />\n \n \n History 111}\n value=\"his111\"\n name=\"courses\"\n onChange={(event) => {\n this.updateValue(event.target.value)\n }}\n checked={this.state.value.indexOf('his111') !== -1}\n />\n \n \n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [value, setValue] = useState(['his111', 'eng203'])\n\n const updateValue = (valueToUpdate) => {\n const index = value.indexOf(valueToUpdate)\n console.log(index)\n if (index === -1) {\n setValue([...value, valueToUpdate])\n } else {\n setValue([...value.slice(0, index), ...value.slice(index + 1)])\n }\n }\n\n return (\n \n Courses to edit\n \n }\n rowSpacing=\"small\"\n >\n Select all courses}\n value=\"all\"\n onChange={() =>\n setValue(value.length === 3 ? [] : ['eng203', 'sci101', 'his111'])\n }\n checked={value.length === 3}\n indeterminate={value.length > 0 && value.length < 3}\n />\n \n English 203}\n value=\"eng203\"\n name=\"courses\"\n onChange={(event) => {\n updateValue(event.target.value)\n }}\n checked={value.indexOf('eng203') !== -1}\n />\n \n \n Science 101}\n value=\"sci101\"\n name=\"courses\"\n onChange={(event) => {\n updateValue(event.target.value)\n }}\n checked={value.indexOf('sci101') !== -1}\n />\n \n \n History 111}\n value=\"his111\"\n name=\"courses\"\n onChange={(event) => {\n updateValue(event.target.value)\n }}\n checked={value.indexOf('his111') !== -1}\n />\n \n \n )\n }\n\n render()\n ```\n\nSetting the `variant` prop to `toggle` turns the checkbox into a toggle switch. For **toggle only** the size prop affects the size of the label and not the actual size of the switch.\n\n```js\n---\ntype: example\n---\nCheckbox examples}>\n \n \n \n\n```\n\nTo change the label placement for the toggle variety, use the labelPlacement prop. The default\nplacement is 'end'.\n\n_Note: the `simple` variant does not support the `labelPlacement`\nproperty._\n\n```js\n---\ntype: example\n---\nToggle label examples}>\n \n \n \n\n```\n\nYou might want to hide the label text when using the toggle switch variant. Do that by wrapping\nthe text in the [ScreenReaderContent](#ScreenReaderContent) component.\n\n```js\n---\ntype: example\n---\nScreenreader-accessible label}\n value=\"accessible\"\n variant=\"toggle\"\n/>\n```\n\n### Guidelines\n\n```js\n---\ntype: embed\n---\n\n

\n Align to the left side of the label\n Use when multiple selections are allowed\n Use to save space from toggles\n Stack vertically if there is more than two options to select\n
\n
\n Run more than two checkboxes horizontally\n
\n\n```\n","displayName":"Checkbox","methods":[],"props":{"label":{"type":{"name":"node"},"required":true,"description":"","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"}},"id":{"type":{"name":"string"},"required":false,"description":"","tsType":{"name":"string"}},"value":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Array of objects with shape: `{\n text: ReactNode,\n type: One of: ['error', 'hint', 'success', 'screenreader-only']\n }`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"defaultChecked":{"type":{"name":"bool"},"required":false,"description":"","tsType":{"name":"boolean"}},"checked":{"type":{"name":"custom","raw":"controllable(PropTypes.bool, 'onChange', 'defaultChecked')"},"required":false,"description":"whether the input is checked or not (must be accompanied by an `onChange` prop)","tsType":{"name":"boolean"}},"onChange":{"type":{"name":"func"},"required":false,"description":"when used with the `checked` prop, the component will not control its own state","tsType":{"name":"signature","type":"function","raw":"(e: React.ChangeEvent) => void","signature":{"arguments":[{"type":{"name":"ReactChangeEvent","raw":"React.ChangeEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onKeyDown":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.KeyboardEvent) => void","signature":{"arguments":[{"type":{"name":"ReactKeyboardEvent","raw":"React.KeyboardEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onFocus":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onMouseOver":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onMouseOut":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"disabled":{"type":{"name":"bool"},"required":false,"description":"Whether or not to disable the checkbox","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"readOnly":{"type":{"name":"bool"},"required":false,"description":"Works just like disabled but keeps the same styles as if it were active","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"indeterminate":{"type":{"name":"bool"},"required":false,"description":"Visual state showing that child checkboxes are a combination of checked and unchecked","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"variant":{"type":{"name":"enum","value":[{"value":"'simple'","computed":false},{"value":"'toggle'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'simple' | 'toggle'","elements":[{"name":"literal","value":"'simple'"},{"name":"literal","value":"'toggle'"}]},"defaultValue":{"value":"'simple'","computed":false}},"inline":{"type":{"name":"bool"},"required":false,"description":"","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"labelPlacement":{"type":{"name":"enum","value":[{"value":"'top'","computed":false},{"value":"'start'","computed":false},{"value":"'end'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'top' | 'start' | 'end'","elements":[{"name":"literal","value":"'top'"},{"name":"literal","value":"'start'"},{"name":"literal","value":"'end'"}]},"defaultValue":{"value":"'end'","computed":false}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","tags":"toggle, switch","relativePath":"packages/ui-checkbox/src/Checkbox/index.tsx","extension":".tsx","srcPath":"packages/ui-checkbox/src/Checkbox/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-checkbox/src/Checkbox/index.tsx","packageName":"@instructure/ui-checkbox","requirePath":"@instructure/ui-checkbox/lib/Checkbox/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-checkbox/src/Checkbox/index.tsx').default","esPath":"@instructure/ui-checkbox/es/Checkbox/index","id":"Checkbox","title":"Checkbox"} \ No newline at end of file +{"description":"\nBy default, the Checkbox component is a custom styled HTML checkbox. To default the checkbox to checked,\nset the `defaultChecked` prop.\n\nAdjust the size of the checkbox and label text via the `size` prop. The default size is\n`medium`.\n\n```js\n---\ntype: example\n---\n\n```\n\nThe default Checkbox in its disabled state:\n\n```js\n---\ntype: example\n---\nCheckbox examples}\n>\n \n \n\n```\n\nThe `indeterminate` property triggers a visual state that handles\nsituations where \"child\" Checkboxes are neither all checked nor all\nunchecked. Note the use of `aria-labelledby` to make the relationship\nbetween the parent and child Checkboxes clear to screenreader users.\n\n_Note: the `toggle` variant does not support the `indeterminate`\nproperty._\n\n- ```js\n class Example extends React.Component {\n constructor(props) {\n super(props)\n\n this.state = {\n value: ['his111', 'eng203']\n }\n }\n\n updateValue(value) {\n const index = this.state.value.indexOf(value)\n\n if (index === -1) {\n this.setState({ value: [...this.state.value, value] })\n } else {\n this.setState((prevState) => ({\n value: [\n ...prevState.value.slice(0, index),\n ...prevState.value.slice(index + 1)\n ]\n }))\n }\n }\n\n render() {\n return (\n \n Courses to edit\n \n }\n rowSpacing=\"small\"\n >\n Select all courses}\n value=\"all\"\n onChange={() =>\n this.setState({\n value:\n this.state.value.length === 3\n ? []\n : ['eng203', 'sci101', 'his111']\n })\n }\n checked={this.state.value.length === 3}\n indeterminate={\n this.state.value.length > 0 && this.state.value.length < 3\n }\n />\n \n English 203}\n value=\"eng203\"\n name=\"courses\"\n onChange={(event) => {\n this.updateValue(event.target.value)\n }}\n checked={this.state.value.indexOf('eng203') !== -1}\n />\n \n \n Science 101}\n value=\"sci101\"\n name=\"courses\"\n onChange={(event) => {\n this.updateValue(event.target.value)\n }}\n checked={this.state.value.indexOf('sci101') !== -1}\n />\n \n \n History 111}\n value=\"his111\"\n name=\"courses\"\n onChange={(event) => {\n this.updateValue(event.target.value)\n }}\n checked={this.state.value.indexOf('his111') !== -1}\n />\n \n \n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [value, setValue] = useState(['his111', 'eng203'])\n\n const updateValue = (valueToUpdate) => {\n const index = value.indexOf(valueToUpdate)\n console.log(index)\n if (index === -1) {\n setValue([...value, valueToUpdate])\n } else {\n setValue([...value.slice(0, index), ...value.slice(index + 1)])\n }\n }\n\n return (\n \n Courses to edit\n \n }\n rowSpacing=\"small\"\n >\n Select all courses}\n value=\"all\"\n onChange={() =>\n setValue(value.length === 3 ? [] : ['eng203', 'sci101', 'his111'])\n }\n checked={value.length === 3}\n indeterminate={value.length > 0 && value.length < 3}\n />\n \n English 203}\n value=\"eng203\"\n name=\"courses\"\n onChange={(event) => {\n updateValue(event.target.value)\n }}\n checked={value.indexOf('eng203') !== -1}\n />\n \n \n Science 101}\n value=\"sci101\"\n name=\"courses\"\n onChange={(event) => {\n updateValue(event.target.value)\n }}\n checked={value.indexOf('sci101') !== -1}\n />\n \n \n History 111}\n value=\"his111\"\n name=\"courses\"\n onChange={(event) => {\n updateValue(event.target.value)\n }}\n checked={value.indexOf('his111') !== -1}\n />\n \n \n )\n }\n\n render()\n ```\n\nSetting the `variant` prop to `toggle` turns the checkbox into a toggle switch. For **toggle only** the size prop affects the size of the label and not the actual size of the switch.\n\n```js\n---\ntype: example\n---\nCheckbox examples}>\n \n \n \n\n```\n\nTo change the label placement for the toggle variety, use the labelPlacement prop. The default\nplacement is 'end'.\n\n_Note: the `simple` variant does not support the `labelPlacement`\nproperty._\n\n```js\n---\ntype: example\n---\nToggle label examples}>\n \n \n \n\n```\n\nYou might want to hide the label text when using the toggle switch variant. Do that by wrapping\nthe text in the [ScreenReaderContent](#ScreenReaderContent) component.\n\n```js\n---\ntype: example\n---\nScreenreader-accessible label}\n value=\"accessible\"\n variant=\"toggle\"\n/>\n```\n\n### Guidelines\n\n```js\n---\ntype: embed\n---\n\n
\n Align to the left side of the label\n Use when multiple selections are allowed\n Use to save space from toggles\n Stack vertically if there is more than two options to select\n
\n
\n Run more than two checkboxes horizontally\n
\n\n```\n\n```js\n---\ntype: embed\n---\n\n
\n Do not add business logic to `onMouseOver` or `onMouseOut` events. These events are not triggered by keyboard navigation\n
\n\n```\n","displayName":"Checkbox","methods":[],"props":{"label":{"type":{"name":"node"},"required":true,"description":"","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"}},"id":{"type":{"name":"string"},"required":false,"description":"","tsType":{"name":"string"}},"value":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Array of objects with shape: `{\n text: ReactNode,\n type: One of: ['error', 'hint', 'success', 'screenreader-only']\n }`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"defaultChecked":{"type":{"name":"bool"},"required":false,"description":"","tsType":{"name":"boolean"}},"checked":{"type":{"name":"custom","raw":"controllable(PropTypes.bool, 'onChange', 'defaultChecked')"},"required":false,"description":"whether the input is checked or not (must be accompanied by an `onChange` prop)","tsType":{"name":"boolean"}},"onChange":{"type":{"name":"func"},"required":false,"description":"when used with the `checked` prop, the component will not control its own state","tsType":{"name":"signature","type":"function","raw":"(e: React.ChangeEvent) => void","signature":{"arguments":[{"type":{"name":"ReactChangeEvent","raw":"React.ChangeEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onKeyDown":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.KeyboardEvent) => void","signature":{"arguments":[{"type":{"name":"ReactKeyboardEvent","raw":"React.KeyboardEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onFocus":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onMouseOver":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"onMouseOut":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent","elements":[{"name":"HTMLInputElement"}]},"name":"e"}],"return":{"name":"void"}}}},"disabled":{"type":{"name":"bool"},"required":false,"description":"Whether or not to disable the checkbox","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"readOnly":{"type":{"name":"bool"},"required":false,"description":"Works just like disabled but keeps the same styles as if it were active","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"indeterminate":{"type":{"name":"bool"},"required":false,"description":"Visual state showing that child checkboxes are a combination of checked and unchecked","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"variant":{"type":{"name":"enum","value":[{"value":"'simple'","computed":false},{"value":"'toggle'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'simple' | 'toggle'","elements":[{"name":"literal","value":"'simple'"},{"name":"literal","value":"'toggle'"}]},"defaultValue":{"value":"'simple'","computed":false}},"inline":{"type":{"name":"bool"},"required":false,"description":"","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"labelPlacement":{"type":{"name":"enum","value":[{"value":"'top'","computed":false},{"value":"'start'","computed":false},{"value":"'end'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'top' | 'start' | 'end'","elements":[{"name":"literal","value":"'top'"},{"name":"literal","value":"'start'"},{"name":"literal","value":"'end'"}]},"defaultValue":{"value":"'end'","computed":false}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","tags":"toggle, switch","relativePath":"packages/ui-checkbox/src/Checkbox/index.tsx","extension":".tsx","srcPath":"packages/ui-checkbox/src/Checkbox/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-checkbox/src/Checkbox/index.tsx","packageName":"@instructure/ui-checkbox","requirePath":"@instructure/ui-checkbox/lib/Checkbox/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-checkbox/src/Checkbox/index.tsx').default","esPath":"@instructure/ui-checkbox/es/Checkbox/index","id":"Checkbox","title":"Checkbox"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/Children.json b/pr-preview/pr-1690/docs/Children.json index abf3e8c02b..d67aaa3245 100644 --- a/pr-preview/pr-1690/docs/Children.json +++ b/pr-preview/pr-1690/docs/Children.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * @module Children\n */","meta":{"filename":"b036nzisleofaoichp6sy6.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":"szhl16gjf39ljnxt6cq8u.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-1690/docs/DateInput.json b/pr-preview/pr-1690/docs/DateInput.json index 37a47b378b..e51087fa76 100644 --- a/pr-preview/pr-1690/docs/DateInput.json +++ b/pr-preview/pr-1690/docs/DateInput.json @@ -1 +1 @@ -{"description":"\n> **Important:** You can now use are updated version [`DateInput2`](/#DateInput2) which is easier to configure for developers, has a better UX, better accessibility features and a year picker. We recommend using that instead of `DateInput` which will be deprecated in the future.\n\nThe `DateInput` component provides a visual interface for inputting date data.\n\n### Composing a DateInput in your Application\n\n`DateInput` uses `Calendar` internally. See [Calendar](#Calendar) for more detailed\ndocumentation and guided examples. `DateInput` shares many of the same `Calendar`\nprops and it is created the same way with some additional attributes and callback\nmethods for the input. The following example is configured similar to the `Calendar`\nexamples using [Moment.js](https://momentjs.com/docs/#/parsing/).\n\n```javascript\n---\ntype: example\n---\n\nclass Example extends React.Component {\n state = {\n value: '',\n isShowingCalendar: false,\n todayDate: parseDate('2019-08-28').toISOString(),\n selectedDate: null,\n renderedDate: parseDate('2019-08-01').toISOString(),\n disabledDates: [\n parseDate('2019-08-14').toISOString(),\n parseDate('2019-08-19').toISOString(),\n parseDate('2019-08-29').toISOString()\n ],\n messages: []\n }\n\n generateMonth = (renderedDate = this.state.renderedDate) => {\n const date = parseDate(renderedDate)\n .startOf('month')\n .startOf('week')\n\n return Array.apply(null, Array(Calendar.DAY_COUNT)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'days')\n return currentDate\n })\n }\n\n formatDate = (dateInput) => {\n const date = parseDate(dateInput)\n return `${date.format('MMMM')} ${date.format('D')}, ${date.format('YYYY')}`\n }\n\n handleChange = (event, { value }) => {\n const newDateStr = parseDate(value).toISOString()\n\n this.setState(({ renderedDate }) => ({\n value,\n selectedDate: newDateStr,\n renderedDate: newDateStr || renderedDate,\n messages: []\n }))\n }\n\n handleShowCalendar = (event) => {\n this.setState({ isShowingCalendar: true })\n }\n\n handleHideCalendar = (event) => {\n this.setState(({ selectedDate, disabledDates, value }) => ({\n isShowingCalendar: false,\n value: selectedDate ? this.formatDate(selectedDate) : value\n }))\n }\n\n handleValidateDate = (event) => {\n this.setState(({ selectedDate, value }) => {\n // We don't have a selectedDate but we have a value. That means that the value\n // could not be parsed and so the date is invalid\n if (!selectedDate && value) {\n return {\n messages: [{ type: 'error', text: 'This date is invalid' }],\n }\n }\n // Display a message if the user has typed in a value that corresponds to a\n // disabledDate\n if (this.isDisabledDate(parseDate(selectedDate))) {\n return {\n messages: [{ type: 'error', text: 'This date is disabled' }],\n }\n }\n })\n }\n\n handleDayClick = (event, { date }) => {\n this.setState({\n selectedDate: date,\n renderedDate: date,\n messages: []\n })\n }\n\n handleSelectNextDay = (event) => {\n this.modifySelectedDate('day', 1)\n }\n\n handleSelectPrevDay = (event) => {\n this.modifySelectedDate('day', -1)\n }\n\n handleRenderNextMonth = (event) => {\n this.modifyRenderedDate('month', 1)\n }\n\n handleRenderPrevMonth = (event) => {\n this.modifyRenderedDate('month', -1)\n }\n\n modifyRenderedDate = (type, step) => {\n this.setState(({ renderedDate }) => {\n return { renderedDate: this.modifyDate(renderedDate, type, step) }\n })\n }\n\n modifySelectedDate = (type, step) => {\n this.setState(({ selectedDate, renderedDate }) => {\n // We are either going to increase or decrease our selectedDate by 1 day.\n // If we do not have a selectedDate yet, we'll just select the first day of\n // the currently rendered month instead.\n const newDate = selectedDate\n ? this.modifyDate(selectedDate, type, step)\n : parseDate(renderedDate).startOf('month').toISOString()\n\n return {\n selectedDate: newDate,\n renderedDate: newDate,\n value: this.formatDate(newDate),\n messages: []\n }\n })\n }\n\n modifyDate = (dateStr, type, step) => {\n const date = parseDate(dateStr)\n date.add(step, type)\n return date.toISOString()\n }\n\n isDisabledDate = (date, disabledDates = this.state.disabledDates) => {\n return disabledDates.reduce((result, disabledDate) => {\n return result || date.isSame(disabledDate, 'day')\n }, false)\n }\n\n renderWeekdayLabels = () => {\n const date = parseDate(this.state.renderedDate).startOf('week')\n\n return Array.apply(null, Array(7)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'day')\n\n return (\n \n {currentDate.format('dd')}\n \n )\n })\n }\n\n renderDays () {\n const {\n renderedDate,\n selectedDate,\n todayDate,\n } = this.state\n\n return this.generateMonth().map((date) => {\n const dateStr = date.toISOString()\n\n return (\n \n {date.format('D')}\n \n )\n })\n }\n\n render () {\n const {\n value,\n isShowingCalendar,\n renderedDate,\n messages\n } = this.state\n\n const date = parseDate(this.state.renderedDate)\n\n const buttonProps = (type = 'prev') => ({\n size: 'small',\n withBackground: false,\n withBorder: false,\n renderIcon: type === 'prev'\n ? \n : ,\n screenReaderLabel: type === 'prev' ? 'Previous month' : 'Next month'\n })\n\n return (\n \n
{date.format('MMMM')}
\n
{date.format('YYYY')}
\n \n }\n renderPrevMonthButton={}\n renderNextMonthButton={}\n renderWeekdayLabels={this.renderWeekdayLabels()}\n >\n {this.renderDays()}\n \n )\n }\n}\n\nconst locale = 'en-us'\nconst timezone = 'America/Denver'\n\nconst parseDate = (dateStr) => {\n return moment.tz(dateStr, [moment.ISO_8601, 'llll', 'LLLL', 'lll', 'LLL', 'll', 'LL', 'l', 'L'], locale, timezone)\n}\n\nrender()\n```\n\n#### Some dates to keep track of\n\n- `todayDate` - the date that represents today\n- `selectedDate` - the user's selected date\n- `renderedDate` - the date that the user is viewing as they navigate the `Calendar`\n- `disabledDates` - any dates that are disabled\n\n#### Rendering `DateInput.Day` children\n\n`DateInput` accepts children of type `DateInput.Day`. Both `DateInput.Day` and\n`Calendar.Day` are exporting the same `Day` component. The documentation for\n`Day` can be found in [Calendar](#Calendar).\n\n#### Handling onChange\n\nWhen the `DateInput` fires an `onChange` event:\n\n- The value should be updated and any messages should be cleared\n- Verify if the value can be parsed as a date\n- If it can be parsed, update the `selectedDate` and `renderedDate` with that date\n- If it cannot be parsed, the `selectedDate` is set to null and the `renderedDate`\n stays the same\n\n#### Handling onRequestHideCalendar\n\nWhen the `DateInput` fires `onRequestHideCalendar`:\n\n- The calendar should be hidden\n- The value should be updated with a formatted version of the `selectedDate` if\n it exists. See \"Formatting user input\" below\n\n#### Formatting user input\n\nDate formats can vary widely (ex. '8-9-19' vs '8/9/19'). When the `Calendar` is\nhidden, the input value should be converted to a consistent, standardized format.\nThe formatted result of the raw input '8/9/19'\ncould be \"August 9, 2019\".\n\n#### Handling onRequestValidateDate\n\nWhen the `DateInput` fires `onRequestValidateDate`, the provided user input\nshould be validated. If the value cannot be parsed as a valid date, or if the\n`selectedDate` is disabled, the user should be notified via the `messages` prop.\n","displayName":"DateInput","methods":[],"props":{"renderLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"Specifies the input label.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"value":{"type":{"name":"custom","raw":"controllable(PropTypes.string)"},"required":false,"description":"Specifies the input value.","tsType":{"name":"string"},"defaultValue":{"value":"''","computed":false}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Specifies the input size.","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"placeholder":{"type":{"name":"string"},"required":false,"description":"Html placeholder text to display when the input has no value. This should\nbe hint text, not a label replacement.","tsType":{"name":"string"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a change event.\n@param {Object} event - the event object\n@param {Object} data - additional data\n@param data.value - the new value","tsType":{"name":"signature","type":"function","raw":"(\n event: React.ChangeEvent,\n value: { value: string }\n) => void","signature":{"arguments":[{"type":{"name":"ReactChangeEvent","raw":"React.ChangeEvent","elements":[{"name":"HTMLInputElement"}]},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ value: string }","signature":{"properties":[{"key":"value","value":{"name":"string","required":true}}]}},"name":"value"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a blur event.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}},"defaultValue":{"value":"() => {}","computed":false}},"interaction":{"type":{"name":"enum","value":[{"value":"'enabled'","computed":false},{"value":"'disabled'","computed":false},{"value":"'readonly'","computed":false}]},"required":false,"description":"Specifies if interaction with the input is enabled, disabled, or readonly.\nWhen \"disabled\", the input changes visibly to indicate that it cannot\nreceive user interactions. When \"readonly\" the input still cannot receive\nuser interactions but it keeps the same styles as if it were enabled.","tsType":{"name":"union","raw":"'enabled' | 'disabled' | 'readonly'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"},{"name":"literal","value":"'readonly'"}]}},"isRequired":{"type":{"name":"bool"},"required":false,"description":"Specifies if the input is required.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"isInline":{"type":{"name":"bool"},"required":false,"description":"Controls whether the input is rendered inline with other elements or if it\nis rendered as a block level element.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"assistiveText":{"type":{"name":"string"},"required":false,"description":"Additional helpful text to provide to screen readers about the operation\nof the component.","tsType":{"name":"string"}},"layout":{"type":{"name":"enum","value":[{"value":"'stacked'","computed":false},{"value":"'inline'","computed":false}]},"required":false,"description":"Controls the layout. When set to `stacked`, the label rests on top of the\ninput. When set to `inline` the label is next to the input.","tsType":{"name":"union","raw":"'stacked' | 'inline'","elements":[{"name":"literal","value":"'stacked'"},{"name":"literal","value":"'inline'"}]},"defaultValue":{"value":"'stacked'","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"Specifies the width of the input.","tsType":{"name":"string"}},"display":{"type":{"name":"enum","value":[{"value":"'inline-block'","computed":false},{"value":"'block'","computed":false}]},"required":false,"description":"Specifies the display property of the container.","tsType":{"name":"union","raw":"'inline-block' | 'block'","elements":[{"name":"literal","value":"'inline-block'"},{"name":"literal","value":"'block'"}]},"defaultValue":{"value":"'inline-block'","computed":false}},"inputRef":{"type":{"name":"func"},"required":false,"description":"Provides a ref to the underlying input element.","tsType":{"name":"signature","type":"function","raw":"(element: HTMLInputElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLInputElement | null","elements":[{"name":"HTMLInputElement"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Displays messages and validation for the input. It should be an object\nwith the following shape:\n`{\n text: PropTypes.node,\n type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])\n}`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"placement":{"type":{"name":"custom","raw":"PositionPropTypes.placement"},"required":false,"description":"The placement of the calendar in relation to the input.","tsType":{"name":"PlacementPropValues"},"defaultValue":{"value":"'bottom center'","computed":false}},"isShowingCalendar":{"type":{"name":"bool"},"required":false,"description":"Controls whether the calendar is showing.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"onRequestValidateDate":{"type":{"name":"func"},"required":false,"description":"Callback fired when the input is blurred. Feedback should be provided\nto the user when this function is called if the selected date or input\nvalue is not valid. The component calculates date validity and if it's\ndisabled or nor and passes that information to this callback.","tsType":{"name":"signature","type":"function","raw":"(\n event: SyntheticEvent,\n dateString?: string,\n validation?: FormMessage[]\n) => void | FormMessage[]","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"},{"type":{"name":"string"},"name":"dateString"},{"type":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"},"name":"validation"}],"return":{"name":"union","raw":"void | FormMessage[]","elements":[{"name":"void"},{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}]}}}},"onRequestShowCalendar":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the calendar be shown.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestHideCalendar":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the calendar be hidden.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestSelectNextDay":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the next day be selected. If no date is currently\nselected should default to the first day of the currently rendered month.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestSelectPrevDay":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the previous day be selected. If no date is currently\nselected should default to the first day of the currently rendered month.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestRenderNextMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the next month be rendered.","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"}],"return":{"name":"void"}}}},"onRequestRenderPrevMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the previous month be rendered.","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"}],"return":{"name":"void"}}}},"renderNavigationLabel":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"Content to render in the calendar navigation header. The recommendation is\nto include the name of the current rendered month along with the year.","tsType":{"name":"union","raw":"React.ReactNode | (() => React.ReactNode)","elements":[{"name":"ReactReactNode","raw":"React.ReactNode"},{"name":"unknown"}]}},"renderWeekdayLabels":{"type":{"name":"arrayOf","value":{"name":"union","value":[{"name":"func"},{"name":"node"}]}},"required":false,"description":"An array of labels containing the name of each day of the week. The visible\nportion of the label should be abbreviated (no longer than three characters).\nNote that screen readers will read this content preceding each date as the\n`` is navigated. Consider using\n[AccessibleContent](#AccessibleContent) with the `alt` prop containing the\nfull day name for assistive technologies and the children containing the\nabbreviation. ex. `[Sun, ...]`","tsType":{"name":"Array","elements":[{"name":"unknown"}],"raw":"(React.ReactNode | (() => React.ReactNode))[]"}},"renderNextMonthButton":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"A button to render in the calendar navigation header. The recommendation is\nto compose it with the [Button](#Button) component, setting the `variant`\nprop to `icon`, the `size` prop to `small`, and setting the `icon` prop to\n[IconArrowOpenEnd](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderPrevMonthButton":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"A button to render in the calendar navigation header. The recommendation is\nto compose it with the [Button](#Button) component, setting the `variant`\nprop to `icon`, the `size` prop to `small`, and setting the `icon` prop to\n[IconArrowOpenStart](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"children":{"type":{"name":"custom","raw":"ChildrenPropTypes.oneOf([Calendar.Day])"},"required":false,"description":"children of type `` There should be exactly 42 provided (6\nweeks).","tsType":{"name":"Array","elements":[{"name":"ReactElement","elements":[{"name":"CalendarDayProps"}],"raw":"ReactElement"}],"raw":"ReactElement[]"}},"disabledDates":{"type":{"name":"union","value":[{"name":"array"},{"name":"func"}]},"required":false,"description":"","tsType":{"name":"union","raw":"string[] | ((isoDateToCheck: string) => boolean)","elements":[{"name":"Array","elements":[{"name":"string"}],"raw":"string[]"},{"name":"unknown"}]}},"currentDate":{"type":{"name":"string"},"required":false,"description":"ISO date string for the current date if necessary. Defaults to the current\ndate in the user's timezone.","tsType":{"name":"string"}},"disabledDateErrorMessage":{"type":{"name":"union","value":[{"name":"func"},{"name":"string"}]},"required":false,"description":"Error message shown to the user if they enter a date that is disabled.\nIf not specified the component will show the `invalidDateTimeMessage`.","tsType":{"name":"union","raw":"string | ((rawDateValue: string) => FormMessage)","elements":[{"name":"string"},{"name":"unknown"}]}},"invalidDateErrorMessage":{"type":{"name":"union","value":[{"name":"func"},{"name":"string"}]},"required":false,"description":"The message shown to the user when the data is invalid.\nIf a string, shown to the user anytime the input is invalid.\n\nIf a function, receives a single parameter:\n- *rawDateValue*: the string entered as a date by the user.","tsType":{"name":"union","raw":"string | ((rawDateValue: string) => FormMessage)","elements":[{"name":"string"},{"name":"unknown"}]}},"locale":{"type":{"name":"string"},"required":false,"description":"A standard language identifier.\n\nSee [Moment.js](https://momentjs.com/timezone/docs/#/using-timezones/parsing-in-zone/) for\nmore details.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's locale will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"timezone":{"type":{"name":"string"},"required":false,"description":"A timezone identifier in the format: *Area/Location*\n\nSee [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list\nof possible options.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's timezone will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"withYearPicker":{"type":{"name":"object"},"required":false,"description":"If set, years can be picked from a dropdown.\nIt accepts an object.\nscreenReaderLabel: string // e.g.: i18n(\"pick a year\")\n\nonRequestYearChange?:(e: React.MouseEvent,requestedYear: number): void // if set, on year change, only this will be called and no internal change will take place\n\nstartYear: number // e.g.: 2001, sets the start year of the selectable list\n\nendYear: number // e.g.: 2030, sets the end year of the selectable list","tsType":{"name":"signature","type":"object","raw":"{\n screenReaderLabel: string\n onRequestYearChange?: (e: any, requestedYear: number) => void\n startYear: number\n endYear: number\n}","signature":{"properties":[{"key":"screenReaderLabel","value":{"name":"string","required":true}},{"key":"onRequestYearChange","value":{"name":"signature","type":"function","raw":"(e: any, requestedYear: number) => void","signature":{"arguments":[{"type":{"name":"any"},"name":"e"},{"type":{"name":"number"},"name":"requestedYear"}],"return":{"name":"void"}},"required":false}},{"key":"startYear","value":{"name":"number","required":true}},{"key":"endYear","value":{"name":"number","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-date-input/src/DateInput/index.tsx","extension":".tsx","srcPath":"packages/ui-date-input/src/DateInput/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-date-input/src/DateInput/index.tsx","packageName":"@instructure/ui-date-input","requirePath":"@instructure/ui-date-input/lib/DateInput/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-date-input/src/DateInput/index.tsx').default","esPath":"@instructure/ui-date-input/es/DateInput/index","id":"DateInput","title":"DateInput"} \ No newline at end of file +{"description":"\n> _Note:_ you can now try the updated (but still experimental) [`DateInput2`](/#DateInput2) which is easier to configure for developers, has a better UX, better accessibility features and a year picker. We recommend using that instead of `DateInput` which will be deprecated in the future.\n\nThe `DateInput` component provides a visual interface for inputting date data.\n\n### Composing a DateInput in your Application\n\n`DateInput` uses `Calendar` internally. See [Calendar](#Calendar) for more detailed\ndocumentation and guided examples. `DateInput` shares many of the same `Calendar`\nprops and it is created the same way with some additional attributes and callback\nmethods for the input. The following example is configured similar to the `Calendar`\nexamples using [Moment.js](https://momentjs.com/docs/#/parsing/).\n\n```javascript\n---\ntype: example\n---\n\nclass Example extends React.Component {\n state = {\n value: '',\n isShowingCalendar: false,\n todayDate: parseDate('2019-08-28').toISOString(),\n selectedDate: null,\n renderedDate: parseDate('2019-08-01').toISOString(),\n disabledDates: [\n parseDate('2019-08-14').toISOString(),\n parseDate('2019-08-19').toISOString(),\n parseDate('2019-08-29').toISOString()\n ],\n messages: []\n }\n\n generateMonth = (renderedDate = this.state.renderedDate) => {\n const date = parseDate(renderedDate)\n .startOf('month')\n .startOf('week')\n\n return Array.apply(null, Array(Calendar.DAY_COUNT)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'days')\n return currentDate\n })\n }\n\n formatDate = (dateInput) => {\n const date = parseDate(dateInput)\n return `${date.format('MMMM')} ${date.format('D')}, ${date.format('YYYY')}`\n }\n\n handleChange = (event, { value }) => {\n const newDateStr = parseDate(value).toISOString()\n\n this.setState(({ renderedDate }) => ({\n value,\n selectedDate: newDateStr,\n renderedDate: newDateStr || renderedDate,\n messages: []\n }))\n }\n\n handleShowCalendar = (event) => {\n this.setState({ isShowingCalendar: true })\n }\n\n handleHideCalendar = (event) => {\n this.setState(({ selectedDate, disabledDates, value }) => ({\n isShowingCalendar: false,\n value: selectedDate ? this.formatDate(selectedDate) : value\n }))\n }\n\n handleValidateDate = (event) => {\n this.setState(({ selectedDate, value }) => {\n // We don't have a selectedDate but we have a value. That means that the value\n // could not be parsed and so the date is invalid\n if (!selectedDate && value) {\n return {\n messages: [{ type: 'error', text: 'This date is invalid' }],\n }\n }\n // Display a message if the user has typed in a value that corresponds to a\n // disabledDate\n if (this.isDisabledDate(parseDate(selectedDate))) {\n return {\n messages: [{ type: 'error', text: 'This date is disabled' }],\n }\n }\n })\n }\n\n handleDayClick = (event, { date }) => {\n this.setState({\n selectedDate: date,\n renderedDate: date,\n messages: []\n })\n }\n\n handleSelectNextDay = (event) => {\n this.modifySelectedDate('day', 1)\n }\n\n handleSelectPrevDay = (event) => {\n this.modifySelectedDate('day', -1)\n }\n\n handleRenderNextMonth = (event) => {\n this.modifyRenderedDate('month', 1)\n }\n\n handleRenderPrevMonth = (event) => {\n this.modifyRenderedDate('month', -1)\n }\n\n modifyRenderedDate = (type, step) => {\n this.setState(({ renderedDate }) => {\n return { renderedDate: this.modifyDate(renderedDate, type, step) }\n })\n }\n\n modifySelectedDate = (type, step) => {\n this.setState(({ selectedDate, renderedDate }) => {\n // We are either going to increase or decrease our selectedDate by 1 day.\n // If we do not have a selectedDate yet, we'll just select the first day of\n // the currently rendered month instead.\n const newDate = selectedDate\n ? this.modifyDate(selectedDate, type, step)\n : parseDate(renderedDate).startOf('month').toISOString()\n\n return {\n selectedDate: newDate,\n renderedDate: newDate,\n value: this.formatDate(newDate),\n messages: []\n }\n })\n }\n\n modifyDate = (dateStr, type, step) => {\n const date = parseDate(dateStr)\n date.add(step, type)\n return date.toISOString()\n }\n\n isDisabledDate = (date, disabledDates = this.state.disabledDates) => {\n return disabledDates.reduce((result, disabledDate) => {\n return result || date.isSame(disabledDate, 'day')\n }, false)\n }\n\n renderWeekdayLabels = () => {\n const date = parseDate(this.state.renderedDate).startOf('week')\n\n return Array.apply(null, Array(7)).map(() => {\n const currentDate = date.clone()\n date.add(1, 'day')\n\n return (\n \n {currentDate.format('dd')}\n \n )\n })\n }\n\n renderDays () {\n const {\n renderedDate,\n selectedDate,\n todayDate,\n } = this.state\n\n return this.generateMonth().map((date) => {\n const dateStr = date.toISOString()\n\n return (\n \n {date.format('D')}\n \n )\n })\n }\n\n render () {\n const {\n value,\n isShowingCalendar,\n renderedDate,\n messages\n } = this.state\n\n const date = parseDate(this.state.renderedDate)\n\n const buttonProps = (type = 'prev') => ({\n size: 'small',\n withBackground: false,\n withBorder: false,\n renderIcon: type === 'prev'\n ? \n : ,\n screenReaderLabel: type === 'prev' ? 'Previous month' : 'Next month'\n })\n\n return (\n \n

{date.format('MMMM')}
\n
{date.format('YYYY')}
\n \n }\n renderPrevMonthButton={}\n renderNextMonthButton={}\n renderWeekdayLabels={this.renderWeekdayLabels()}\n >\n {this.renderDays()}\n \n )\n }\n}\n\nconst locale = 'en-us'\nconst timezone = 'America/Denver'\n\nconst parseDate = (dateStr) => {\n return moment.tz(dateStr, [moment.ISO_8601, 'llll', 'LLLL', 'lll', 'LLL', 'll', 'LL', 'l', 'L'], locale, timezone)\n}\n\nrender()\n```\n\n#### Some dates to keep track of\n\n- `todayDate` - the date that represents today\n- `selectedDate` - the user's selected date\n- `renderedDate` - the date that the user is viewing as they navigate the `Calendar`\n- `disabledDates` - any dates that are disabled\n\n#### Rendering `DateInput.Day` children\n\n`DateInput` accepts children of type `DateInput.Day`. Both `DateInput.Day` and\n`Calendar.Day` are exporting the same `Day` component. The documentation for\n`Day` can be found in [Calendar](#Calendar).\n\n#### Handling onChange\n\nWhen the `DateInput` fires an `onChange` event:\n\n- The value should be updated and any messages should be cleared\n- Verify if the value can be parsed as a date\n- If it can be parsed, update the `selectedDate` and `renderedDate` with that date\n- If it cannot be parsed, the `selectedDate` is set to null and the `renderedDate`\n stays the same\n\n#### Handling onRequestHideCalendar\n\nWhen the `DateInput` fires `onRequestHideCalendar`:\n\n- The calendar should be hidden\n- The value should be updated with a formatted version of the `selectedDate` if\n it exists. See \"Formatting user input\" below\n\n#### Formatting user input\n\nDate formats can vary widely (ex. '8-9-19' vs '8/9/19'). When the `Calendar` is\nhidden, the input value should be converted to a consistent, standardized format.\nThe formatted result of the raw input '8/9/19'\ncould be \"August 9, 2019\".\n\n#### Handling onRequestValidateDate\n\nWhen the `DateInput` fires `onRequestValidateDate`, the provided user input\nshould be validated. If the value cannot be parsed as a valid date, or if the\n`selectedDate` is disabled, the user should be notified via the `messages` prop.\n","displayName":"DateInput","methods":[],"props":{"renderLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"Specifies the input label.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"value":{"type":{"name":"custom","raw":"controllable(PropTypes.string)"},"required":false,"description":"Specifies the input value.","tsType":{"name":"string"},"defaultValue":{"value":"''","computed":false}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Specifies the input size.","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"placeholder":{"type":{"name":"string"},"required":false,"description":"Html placeholder text to display when the input has no value. This should\nbe hint text, not a label replacement.","tsType":{"name":"string"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a change event.\n@param {Object} event - the event object\n@param {Object} data - additional data\n@param data.value - the new value","tsType":{"name":"signature","type":"function","raw":"(\n event: React.ChangeEvent,\n value: { value: string }\n) => void","signature":{"arguments":[{"type":{"name":"ReactChangeEvent","raw":"React.ChangeEvent","elements":[{"name":"HTMLInputElement"}]},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ value: string }","signature":{"properties":[{"key":"value","value":{"name":"string","required":true}}]}},"name":"value"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a blur event.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}},"defaultValue":{"value":"() => {}","computed":false}},"interaction":{"type":{"name":"enum","value":[{"value":"'enabled'","computed":false},{"value":"'disabled'","computed":false},{"value":"'readonly'","computed":false}]},"required":false,"description":"Specifies if interaction with the input is enabled, disabled, or readonly.\nWhen \"disabled\", the input changes visibly to indicate that it cannot\nreceive user interactions. When \"readonly\" the input still cannot receive\nuser interactions but it keeps the same styles as if it were enabled.","tsType":{"name":"union","raw":"'enabled' | 'disabled' | 'readonly'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"},{"name":"literal","value":"'readonly'"}]}},"isRequired":{"type":{"name":"bool"},"required":false,"description":"Specifies if the input is required.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"isInline":{"type":{"name":"bool"},"required":false,"description":"Controls whether the input is rendered inline with other elements or if it\nis rendered as a block level element.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"assistiveText":{"type":{"name":"string"},"required":false,"description":"Additional helpful text to provide to screen readers about the operation\nof the component.","tsType":{"name":"string"}},"layout":{"type":{"name":"enum","value":[{"value":"'stacked'","computed":false},{"value":"'inline'","computed":false}]},"required":false,"description":"Controls the layout. When set to `stacked`, the label rests on top of the\ninput. When set to `inline` the label is next to the input.","tsType":{"name":"union","raw":"'stacked' | 'inline'","elements":[{"name":"literal","value":"'stacked'"},{"name":"literal","value":"'inline'"}]},"defaultValue":{"value":"'stacked'","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"Specifies the width of the input.","tsType":{"name":"string"}},"display":{"type":{"name":"enum","value":[{"value":"'inline-block'","computed":false},{"value":"'block'","computed":false}]},"required":false,"description":"Specifies the display property of the container.","tsType":{"name":"union","raw":"'inline-block' | 'block'","elements":[{"name":"literal","value":"'inline-block'"},{"name":"literal","value":"'block'"}]},"defaultValue":{"value":"'inline-block'","computed":false}},"inputRef":{"type":{"name":"func"},"required":false,"description":"Provides a ref to the underlying input element.","tsType":{"name":"signature","type":"function","raw":"(element: HTMLInputElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLInputElement | null","elements":[{"name":"HTMLInputElement"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Displays messages and validation for the input. It should be an object\nwith the following shape:\n`{\n text: PropTypes.node,\n type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])\n}`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"placement":{"type":{"name":"custom","raw":"PositionPropTypes.placement"},"required":false,"description":"The placement of the calendar in relation to the input.","tsType":{"name":"PlacementPropValues"},"defaultValue":{"value":"'bottom center'","computed":false}},"isShowingCalendar":{"type":{"name":"bool"},"required":false,"description":"Controls whether the calendar is showing.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"onRequestValidateDate":{"type":{"name":"func"},"required":false,"description":"Callback fired when the input is blurred. Feedback should be provided\nto the user when this function is called if the selected date or input\nvalue is not valid. The component calculates date validity and if it's\ndisabled or nor and passes that information to this callback.","tsType":{"name":"signature","type":"function","raw":"(\n event: SyntheticEvent,\n dateString?: string,\n validation?: FormMessage[]\n) => void | FormMessage[]","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"},{"type":{"name":"string"},"name":"dateString"},{"type":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"},"name":"validation"}],"return":{"name":"union","raw":"void | FormMessage[]","elements":[{"name":"void"},{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}]}}}},"onRequestShowCalendar":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the calendar be shown.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestHideCalendar":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the calendar be hidden.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestSelectNextDay":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the next day be selected. If no date is currently\nselected should default to the first day of the currently rendered month.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestSelectPrevDay":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the previous day be selected. If no date is currently\nselected should default to the first day of the currently rendered month.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestRenderNextMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the next month be rendered.","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"}],"return":{"name":"void"}}}},"onRequestRenderPrevMonth":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the previous month be rendered.","tsType":{"name":"signature","type":"function","raw":"(e: React.MouseEvent) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"e"}],"return":{"name":"void"}}}},"renderNavigationLabel":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"Content to render in the calendar navigation header. The recommendation is\nto include the name of the current rendered month along with the year.","tsType":{"name":"union","raw":"React.ReactNode | (() => React.ReactNode)","elements":[{"name":"ReactReactNode","raw":"React.ReactNode"},{"name":"unknown"}]}},"renderWeekdayLabels":{"type":{"name":"arrayOf","value":{"name":"union","value":[{"name":"func"},{"name":"node"}]}},"required":false,"description":"An array of labels containing the name of each day of the week. The visible\nportion of the label should be abbreviated (no longer than three characters).\nNote that screen readers will read this content preceding each date as the\n`` is navigated. Consider using\n[AccessibleContent](#AccessibleContent) with the `alt` prop containing the\nfull day name for assistive technologies and the children containing the\nabbreviation. ex. `[Sun, ...]`","tsType":{"name":"Array","elements":[{"name":"unknown"}],"raw":"(React.ReactNode | (() => React.ReactNode))[]"}},"renderNextMonthButton":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"A button to render in the calendar navigation header. The recommendation is\nto compose it with the [Button](#Button) component, setting the `variant`\nprop to `icon`, the `size` prop to `small`, and setting the `icon` prop to\n[IconArrowOpenEnd](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderPrevMonthButton":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"A button to render in the calendar navigation header. The recommendation is\nto compose it with the [Button](#Button) component, setting the `variant`\nprop to `icon`, the `size` prop to `small`, and setting the `icon` prop to\n[IconArrowOpenStart](#iconography).","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"children":{"type":{"name":"custom","raw":"ChildrenPropTypes.oneOf([Calendar.Day])"},"required":false,"description":"children of type `` There should be exactly 42 provided (6\nweeks).","tsType":{"name":"Array","elements":[{"name":"ReactElement","elements":[{"name":"CalendarDayProps"}],"raw":"ReactElement"}],"raw":"ReactElement[]"}},"disabledDates":{"type":{"name":"union","value":[{"name":"array"},{"name":"func"}]},"required":false,"description":"","tsType":{"name":"union","raw":"string[] | ((isoDateToCheck: string) => boolean)","elements":[{"name":"Array","elements":[{"name":"string"}],"raw":"string[]"},{"name":"unknown"}]}},"currentDate":{"type":{"name":"string"},"required":false,"description":"ISO date string for the current date if necessary. Defaults to the current\ndate in the user's timezone.","tsType":{"name":"string"}},"disabledDateErrorMessage":{"type":{"name":"union","value":[{"name":"func"},{"name":"string"}]},"required":false,"description":"Error message shown to the user if they enter a date that is disabled.\nIf not specified the component will show the `invalidDateTimeMessage`.","tsType":{"name":"union","raw":"string | ((rawDateValue: string) => FormMessage)","elements":[{"name":"string"},{"name":"unknown"}]}},"invalidDateErrorMessage":{"type":{"name":"union","value":[{"name":"func"},{"name":"string"}]},"required":false,"description":"The message shown to the user when the data is invalid.\nIf a string, shown to the user anytime the input is invalid.\n\nIf a function, receives a single parameter:\n- *rawDateValue*: the string entered as a date by the user.","tsType":{"name":"union","raw":"string | ((rawDateValue: string) => FormMessage)","elements":[{"name":"string"},{"name":"unknown"}]}},"locale":{"type":{"name":"string"},"required":false,"description":"A standard language identifier.\n\nSee [Moment.js](https://momentjs.com/timezone/docs/#/using-timezones/parsing-in-zone/) for\nmore details.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's locale will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"timezone":{"type":{"name":"string"},"required":false,"description":"A timezone identifier in the format: *Area/Location*\n\nSee [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list\nof possible options.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's timezone will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"withYearPicker":{"type":{"name":"object"},"required":false,"description":"If set, years can be picked from a dropdown.\nIt accepts an object.\nscreenReaderLabel: string // e.g.: i18n(\"pick a year\")\n\nonRequestYearChange?:(e: React.MouseEvent,requestedYear: number): void // if set, on year change, only this will be called and no internal change will take place\n\nstartYear: number // e.g.: 2001, sets the start year of the selectable list\n\nendYear: number // e.g.: 2030, sets the end year of the selectable list","tsType":{"name":"signature","type":"object","raw":"{\n screenReaderLabel: string\n onRequestYearChange?: (e: any, requestedYear: number) => void\n startYear: number\n endYear: number\n}","signature":{"properties":[{"key":"screenReaderLabel","value":{"name":"string","required":true}},{"key":"onRequestYearChange","value":{"name":"signature","type":"function","raw":"(e: any, requestedYear: number) => void","signature":{"arguments":[{"type":{"name":"any"},"name":"e"},{"type":{"name":"number"},"name":"requestedYear"}],"return":{"name":"void"}},"required":false}},{"key":"startYear","value":{"name":"number","required":true}},{"key":"endYear","value":{"name":"number","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-date-input/src/DateInput/index.tsx","extension":".tsx","srcPath":"packages/ui-date-input/src/DateInput/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-date-input/src/DateInput/index.tsx","packageName":"@instructure/ui-date-input","requirePath":"@instructure/ui-date-input/lib/DateInput/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-date-input/src/DateInput/index.tsx').default","esPath":"@instructure/ui-date-input/es/DateInput/index","id":"DateInput","title":"DateInput"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/DateInput2.json b/pr-preview/pr-1690/docs/DateInput2.json index 9ac7dd9714..7ba68e98c9 100644 --- a/pr-preview/pr-1690/docs/DateInput2.json +++ b/pr-preview/pr-1690/docs/DateInput2.json @@ -1 +1 @@ -{"description":"\nThis component is an updated version of [`DateInput`](/#DateInput) that's easier to configure for developers, has a better UX, better accessibility features and a year picker. We recommend using this instead of `DateInput` which will be deprecated in the future.\n\n### Minimal config\n\n- ```js\n class Example extends React.Component {\n state = { value: '' }\n\n render() {\n return (\n this.setState({ value })}\n invalidDateErrorMessage=\"Invalid date\"\n />\n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [value, setValue] = useState('')\n return (\n setValue(value)}\n invalidDateErrorMessage=\"Invalid date\"\n />\n )\n }\n\n render()\n ```\n\n### With year picker\n\n- ```js\n class Example extends React.Component {\n state = { value: '' }\n\n render() {\n return (\n this.setState({ value })}\n invalidDateErrorMessage=\"Invalid date\"\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1900,\n endYear: 2024\n }}\n />\n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [value, setValue] = useState('')\n\n return (\n setValue(value)}\n invalidDateErrorMessage=\"Invalid date\"\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1900,\n endYear: 2024\n }}\n />\n )\n }\n\n render()\n ```\n\n### With custom validation\n\n```js\n---\ntype: example\n---\nconst Example = () => {\n const [value, setValue] = useState('')\n const [messages, setMessages] = useState([])\n\n const handleDateValidation = (dateString, isValidDate) => {\n if (!isValidDate) {\n setMessages([{\n type: 'error',\n text: 'This is not a valid date'\n }])\n } else if (new Date(dateString) < new Date('January 1, 1900')) {\n setMessages([{\n type: 'error',\n text: 'Use date after January 1, 1900'\n }])\n } else {\n setMessages([])\n }\n }\n\n return (\n setValue(value)}\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1900,\n endYear: 2024\n }}\n />\n )\n}\n\nrender()\n```\n","displayName":"DateInput2","methods":[],"props":{"renderLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"Specifies the input label.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"screenReaderLabels":{"type":{"name":"object"},"required":true,"description":"","tsType":{"name":"signature","type":"object","raw":"{\n calendarIcon: string\n prevMonthButton: string\n nextMonthButton: string\n}","signature":{"properties":[{"key":"calendarIcon","value":{"name":"string","required":true}},{"key":"prevMonthButton","value":{"name":"string","required":true}},{"key":"nextMonthButton","value":{"name":"string","required":true}}]}}},"value":{"type":{"name":"custom","raw":"controllable(PropTypes.string)"},"required":false,"description":"Specifies the input value.","tsType":{"name":"string"}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Specifies the input size.","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"placeholder":{"type":{"name":"string"},"required":false,"description":"Html placeholder text to display when the input has no value. This should\nbe hint text, not a label replacement.","tsType":{"name":"string"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Callback fired when the input changes.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent, value: string) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"},{"type":{"name":"string"},"name":"value"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a blur event.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"interaction":{"type":{"name":"enum","value":[{"value":"'enabled'","computed":false},{"value":"'disabled'","computed":false},{"value":"'readonly'","computed":false}]},"required":false,"description":"Specifies if interaction with the input is enabled, disabled, or readonly.\nWhen \"disabled\", the input changes visibly to indicate that it cannot\nreceive user interactions. When \"readonly\" the input still cannot receive\nuser interactions but it keeps the same styles as if it were enabled.","tsType":{"name":"union","raw":"'enabled' | 'disabled' | 'readonly'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"},{"name":"literal","value":"'readonly'"}]},"defaultValue":{"value":"'enabled'","computed":false}},"isRequired":{"type":{"name":"bool"},"required":false,"description":"Specifies if the input is required.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"isInline":{"type":{"name":"bool"},"required":false,"description":"Controls whether the input is rendered inline with other elements or if it\nis rendered as a block level element.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"Specifies the width of the input.","tsType":{"name":"string"}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Displays messages and validation for the input. It should be an object\nwith the following shape:\n`{\n text: PropTypes.node,\n type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])\n}`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"onRequestShowCalendar":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the calendar be shown.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestHideCalendar":{"type":{"name":"func"},"required":false,"description":"Callback fired requesting the calendar be hidden.","tsType":{"name":"signature","type":"function","raw":"(event: SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onRequestValidateDate":{"type":{"name":"func"},"required":false,"description":"Callback fired when the input is blurred. Feedback should be provided\nto the user when this function is called if the selected date or input\nvalue is invalid. The component has an internal check whether the date can\nbe parsed to a valid date.","tsType":{"name":"signature","type":"function","raw":"(\n value?: string,\n internalValidationPassed?: boolean\n) => void | FormMessage[]","signature":{"arguments":[{"type":{"name":"string"},"name":"value"},{"type":{"name":"boolean"},"name":"internalValidationPassed"}],"return":{"name":"union","raw":"void | FormMessage[]","elements":[{"name":"void"},{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}]}}}},"invalidDateErrorMessage":{"type":{"name":"union","value":[{"name":"func"},{"name":"string"}]},"required":false,"description":"The message shown to the user when the date is invalid. If this prop is not set, validation is bypassed.\nIf it's set to an empty string, validation happens and the input border changes to red if validation hasn't passed.","tsType":{"name":"string"}},"locale":{"type":{"name":"string"},"required":false,"description":"A standard language identifier.\n\nSee [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#locales) for\nmore details.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's locale will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"timezone":{"type":{"name":"string"},"required":false,"description":"A timezone identifier in the format: *Area/Location*\n\nSee [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list\nof possible options.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's timezone will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"withYearPicker":{"type":{"name":"object"},"required":false,"description":"If set, years can be picked from a dropdown.\nIt accepts an object.\nscreenReaderLabel: string // e.g.: i18n(\"pick a year\")\n\nonRequestYearChange?:(e: React.MouseEvent,requestedYear: number): void // if set, on year change, only this will be called and no internal change will take place\n\nstartYear: number // e.g.: 2001, sets the start year of the selectable list\n\nendYear: number // e.g.: 2030, sets the end year of the selectable list","tsType":{"name":"signature","type":"object","raw":"{\n screenReaderLabel: string\n onRequestYearChange?: (e: SyntheticEvent, requestedYear: number) => void\n startYear: number\n endYear: number\n}","signature":{"properties":[{"key":"screenReaderLabel","value":{"name":"string","required":true}},{"key":"onRequestYearChange","value":{"name":"signature","type":"function","raw":"(e: SyntheticEvent, requestedYear: number) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"e"},{"type":{"name":"number"},"name":"requestedYear"}],"return":{"name":"void"}},"required":false}},{"key":"startYear","value":{"name":"number","required":true}},{"key":"endYear","value":{"name":"number","required":true}}]}}}},"category":"components","relativePath":"packages/ui-date-input/src/DateInput2/index.tsx","extension":".tsx","srcPath":"packages/ui-date-input/src/DateInput2/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-date-input/src/DateInput2/index.tsx","packageName":"@instructure/ui-date-input","requirePath":"@instructure/ui-date-input/lib/DateInput2/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-date-input/src/DateInput2/index.tsx').default","esPath":"@instructure/ui-date-input/es/DateInput2/index","id":"DateInput2","title":"DateInput2"} \ No newline at end of file +{"description":"\n@module experimental\n> _Warning_: `DateInput2` is an **experimental** upgrade to the existing [`DateInput`](/#DateInput) component, offering easier configuration, better UX, improved accessibility, and a year picker. While it addresses key limitations of `DateInput`, it's still in the experimental phase, with some missing unit tests and potential API changes.\n\n### Minimal config\n\n- ```js\n class Example extends React.Component {\n state = { inputValue: '', dateString: '' }\n\n render() {\n return (\n

\n {\n this.setState({ dateString, inputValue })\n }}\n invalidDateErrorMessage=\"Invalid date\"\n />\n

\n Input Value: {this.state.inputValue}\n
\n UTC Date String: {this.state.dateString}\n

\n
\n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [inputValue, setInputValue] = useState('')\n const [dateString, setDateString] = useState('')\n return (\n
\n {\n setInputValue(inputValue)\n setDateString(dateString)\n }}\n invalidDateErrorMessage=\"Invalid date\"\n />\n

\n Input Value: {inputValue}\n
\n UTC Date String: {dateString}\n

\n
\n )\n }\n\n render()\n ```\n\n### Parsing and formatting dates\n\nWhen typing in a date manually (instead of using the included picker), the component tries to parse the date as you type it in. By default parsing is based on the user's locale which determines the order of day, month and year (e.g.: a user with US locale will have MONTH/DAY/YEAR order, and someone with GB locale will have DAY/MONTH/YEAR order).\n\nAny of the following separators can be used when typing a date: `,`, `-`, `.`, `/` or a whitespace however on blur the date will be formatted according to the locale and separators will be changed and leading zeros also adjusted.\n\nIf you want different parsing and formatting then the current locale you can use the `dateFormat` prop which accepts either a string with a name of a different locale (so you can use US date format even if the user is France) or a parser and formatter functions.\n\nThe default parser also has a limitation of not working with years before `1000` and after `9999`. These values are invalid by default but not with custom parsers.\n\n```js\n---\ntype: example\n---\nconst Example = () => {\n const [value, setValue] = useState('')\n const [value2, setValue2] = useState('')\n const [value3, setValue3] = useState('')\n\n return (\n
\n

US locale with default format:

\n setValue(value)}\n />\n

US locale with german date format:

\n setValue2(value)}\n />\n

US locale with ISO date format:

\n {\n // split input on '.', whitespace, '/', ',' or '-' using regex: /[.\\s/.-]+/\n // the '+' allows splitting on consecutive delimiters\n const [year, month, day] = input.split(/[,.\\s/.-]+/)\n const newDate = new Date(year, month-1, day)\n return isNaN(newDate) ? '' : newDate\n },\n formatter: (date) => {\n // vanilla js formatter but you could use a date library instead\n const year = date.getFullYear()\n // month is zero indexed so add 1\n const month = `${date.getMonth() + 1}`.padStart(2, '0')\n const day = `${date.getDate()}`.padStart(2, '0')\n return `${year}-${month}-${day}`\n }\n }}\n onChange={(e, value) => setValue3(value)}\n />\n
\n )\n}\n\nrender()\n```\n\n### Timezones\n\nIn the examples above you can see that the `onChange` callback also return a UTC date string. This means it is timezone adjusted. If the timezone is not set via the `timezone` prop, it is calculated/assumed from the user's machine. So if a user chooses September 10th 2024 with the timezone 'Europe/Budapest', the `onChange` function will return `2024-09-09T22:00:00.000Z` because Budapest is two hours ahead of UTC (summertime).\n\n### With year picker\n\n- ```js\n class Example extends React.Component {\n state = { inputValue: '', dateString: '' }\n\n render() {\n return (\n
\n {\n this.setState({ dateString, inputValue })\n }}\n invalidDateErrorMessage=\"Invalid date\"\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1900,\n endYear: 2024\n }}\n />\n

\n Input Value: {this.state.inputValue}\n
\n UTC Date String: {this.state.dateString}\n

\n
\n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [inputValue, setInputValue] = useState('')\n const [dateString, setDateString] = useState('')\n return (\n
\n {\n setInputValue(inputValue)\n setDateString(dateString)\n }}\n invalidDateErrorMessage=\"Invalid date\"\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1900,\n endYear: 2024\n }}\n />\n

\n Input Value: {inputValue}\n
\n UTC Date String: {dateString}\n

\n
\n )\n }\n\n render()\n ```\n\n### Date validation\n\nBy default `DateInput2` only does date validation if the `invalidDateErrorMessage` prop is provided. Validation is triggered on the blur event of the input field. Invalid dates are determined current locale.\n\nIf you want to do more complex validation (e.g. only allow a subset of dates) you can use the `onRequestValidateDate` and `messages` props.\n\n```js\n---\ntype: example\n---\nconst Example = () => {\n const [value, setValue] = useState('')\n const [dateString, setDateString] = useState('')\n const [messages, setMessages] = useState([])\n\n const handleDateValidation = (e, inputValue, utcIsoDate) => {\n // utcIsoDate will be an empty string if the input cannot be parsed as a date\n\n const date = new Date(utcIsoDate)\n\n // don't validate empty input\n if (!utcIsoDate && inputValue.length > 0) {\n setMessages([{\n type: 'error',\n text: 'This is not a valid date'\n }])\n } else if (date < new Date('1990-01-01')) {\n setMessages([{\n type: 'error',\n text: 'Select date after January 1, 1990'\n }])\n } else {\n setMessages([])\n }\n }\n\n return (\n setValue(value)}\n withYearPicker={{\n screenReaderLabel: 'Year picker',\n startYear: 1900,\n endYear: 2024\n }}\n />\n )\n}\n\nrender()\n```\n\n### Date format hint\n\nIf the `placeholder` property is undefined it will display a hint for the date format (like `DD/MM/YYYY`). Usually it is recommended to leave it as it is for a better user experience.\n","displayName":"DateInput2","methods":[],"props":{"renderLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"Specifies the input label.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"screenReaderLabels":{"type":{"name":"object"},"required":true,"description":"","tsType":{"name":"signature","type":"object","raw":"{\n calendarIcon: string\n prevMonthButton: string\n nextMonthButton: string\n}","signature":{"properties":[{"key":"calendarIcon","value":{"name":"string","required":true}},{"key":"prevMonthButton","value":{"name":"string","required":true}},{"key":"nextMonthButton","value":{"name":"string","required":true}}]}}},"value":{"type":{"name":"custom","raw":"controllable(PropTypes.string)"},"required":false,"description":"Specifies the input value.","tsType":{"name":"string"}},"placeholder":{"type":{"name":"string"},"required":false,"description":"Placeholder text for the input field. If it's left undefined it will display a hint for the date format (like `DD/MM/YYYY`).","tsType":{"name":"string"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Callback fired when the input changes.","tsType":{"name":"signature","type":"function","raw":"(\n event: React.SyntheticEvent,\n inputValue: string,\n utcDateString: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"},{"type":{"name":"string"},"name":"inputValue"},{"type":{"name":"string"},"name":"utcDateString"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a blur event.","tsType":{"name":"signature","type":"function","raw":"(\n event: React.SyntheticEvent,\n value: string,\n utcDateString: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"},{"type":{"name":"string"},"name":"value"},{"type":{"name":"string"},"name":"utcDateString"}],"return":{"name":"void"}}}},"interaction":{"type":{"name":"enum","value":[{"value":"'enabled'","computed":false},{"value":"'disabled'","computed":false},{"value":"'readonly'","computed":false}]},"required":false,"description":"Specifies if interaction with the input is enabled, disabled, or readonly.\nWhen \"disabled\", the input changes visibly to indicate that it cannot\nreceive user interactions. When \"readonly\" the input still cannot receive\nuser interactions but it keeps the same styles as if it were enabled.","tsType":{"name":"union","raw":"'enabled' | 'disabled' | 'readonly'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"},{"name":"literal","value":"'readonly'"}]},"defaultValue":{"value":"'enabled'","computed":false}},"isRequired":{"type":{"name":"bool"},"required":false,"description":"Specifies if the input is required.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"isInline":{"type":{"name":"bool"},"required":false,"description":"Controls whether the input is rendered inline with other elements or if it\nis rendered as a block level element.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"Specifies the width of the input.","tsType":{"name":"string"}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Displays messages and validation for the input. It should be an object\nwith the following shape:\n`{\n text: PropTypes.node,\n type: PropTypes.oneOf(['error', 'hint', 'success', 'screenreader-only'])\n}`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"invalidDateErrorMessage":{"type":{"name":"union","value":[{"name":"func"},{"name":"string"}]},"required":false,"description":"The message shown to the user when the date is invalid. If this prop is not set, validation is bypassed.\nIf it's set to an empty string, validation happens and the input border changes to red if validation hasn't passed.","tsType":{"name":"string"}},"locale":{"type":{"name":"string"},"required":false,"description":"A standard language identifier.\n\nSee [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#locales) for\nmore details.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe web browser's locale will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"timezone":{"type":{"name":"string"},"required":false,"description":"A timezone identifier in the format: *Area/Location*\n\nSee [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the list\nof possible options.\n\nThis property can also be set via a context property and if both are set\nthen the component property takes precedence over the context property.\n\nThe system timezone will be used if no value is set via a component\nproperty or a context property.","tsType":{"name":"string"}},"withYearPicker":{"type":{"name":"object"},"required":false,"description":"If set, years can be picked from a dropdown.\nIt accepts an object.\nscreenReaderLabel: string // e.g.: i18n(\"pick a year\")\n\nonRequestYearChange?:(e: React.MouseEvent,requestedYear: number): void // if set, on year change, only this will be called and no internal change will take place\n\nstartYear: number // e.g.: 2001, sets the start year of the selectable list\n\nendYear: number // e.g.: 2030, sets the end year of the selectable list","tsType":{"name":"signature","type":"object","raw":"{\n screenReaderLabel: string\n onRequestYearChange?: (e: SyntheticEvent, requestedYear: number) => void\n startYear: number\n endYear: number\n}","signature":{"properties":[{"key":"screenReaderLabel","value":{"name":"string","required":true}},{"key":"onRequestYearChange","value":{"name":"signature","type":"function","raw":"(e: SyntheticEvent, requestedYear: number) => void","signature":{"arguments":[{"type":{"name":"SyntheticEvent"},"name":"e"},{"type":{"name":"number"},"name":"requestedYear"}],"return":{"name":"void"}},"required":false}},{"key":"startYear","value":{"name":"number","required":true}},{"key":"endYear","value":{"name":"number","required":true}}]}}},"dateFormat":{"type":{"name":"union","value":[{"name":"string"},{"name":"object"}]},"required":false,"description":"By default the date format is determined by the locale but can be changed via this prop to an alternate locale (passing it in as a string) or a custom parser and formatter (both as functions)","tsType":{"name":"union","raw":"| {\n parser: (input: string) => Date | null\n formatter: (date: Date) => string\n }\n| string","elements":[{"name":"signature","type":"object","raw":"{\n parser: (input: string) => Date | null\n formatter: (date: Date) => string\n}","signature":{"properties":[{"key":"parser","value":{"name":"signature","type":"function","raw":"(input: string) => Date | null","signature":{"arguments":[{"type":{"name":"string"},"name":"input"}],"return":{"name":"union","raw":"Date | null","elements":[{"name":"Date"},{"name":"null"}]}},"required":true}},{"key":"formatter","value":{"name":"signature","type":"function","raw":"(date: Date) => string","signature":{"arguments":[{"type":{"name":"Date"},"name":"date"}],"return":{"name":"string"}},"required":true}}]}},{"name":"string"}]}},"onRequestValidateDate":{"type":{"name":"func"},"required":false,"description":"Callback executed when the input fires a blur event or a date is selected from the picker.","tsType":{"name":"signature","type":"function","raw":"(\n event: React.SyntheticEvent,\n value: string,\n utcDateString: string\n) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"},{"type":{"name":"string"},"name":"value"},{"type":{"name":"string"},"name":"utcDateString"}],"return":{"name":"void"}}}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-date-input/src/DateInput2/index.tsx","extension":".tsx","srcPath":"packages/ui-date-input/src/DateInput2/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-date-input/src/DateInput2/index.tsx","packageName":"@instructure/ui-date-input","requirePath":"@instructure/ui-date-input/lib/DateInput2/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-date-input/src/DateInput2/index.tsx').default","esPath":"@instructure/ui-date-input/es/DateInput2/index","id":"DateInput2","title":"DateInput2"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/DateTime.json b/pr-preview/pr-1690/docs/DateTime.json index 835bdcf901..cfe0a5b7a0 100644 --- a/pr-preview/pr-1690/docs/DateTime.json +++ b/pr-preview/pr-1690/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":"2vytyt9yr1r1cgsv0alncf.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":"mhmih5t853cdi11ou0eiur.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-1690/docs/FocusRegion.json b/pr-preview/pr-1690/docs/FocusRegion.json index e6ade25963..f6b511e003 100644 --- a/pr-preview/pr-1690/docs/FocusRegion.json +++ b/pr-preview/pr-1690/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":"5xmlae35yf8kse7vu49sck.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":"nymznbfvyul0zsfxflv442p.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-1690/docs/FocusRegionManager.json b/pr-preview/pr-1690/docs/FocusRegionManager.json index 09edf6a37e..f8764a507c 100644 --- a/pr-preview/pr-1690/docs/FocusRegionManager.json +++ b/pr-preview/pr-1690/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":"zi8n3e0hu2r59pl5wn2cyj.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":"m598ercsscraydg8h9j1ol.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-1690/docs/FormPropTypes.json b/pr-preview/pr-1690/docs/FormPropTypes.json index 473ace5e26..1bc7020029 100644 --- a/pr-preview/pr-1690/docs/FormPropTypes.json +++ b/pr-preview/pr-1690/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":"3bfpa3nlbe6tb5jyrekd9.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":"zcbk4rieyqiu9os5gxel2.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-1690/docs/I18nPropTypes.json b/pr-preview/pr-1690/docs/I18nPropTypes.json index 6713222c4a..632c3de469 100644 --- a/pr-preview/pr-1690/docs/I18nPropTypes.json +++ b/pr-preview/pr-1690/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":"xuv519vafkakep6y85x9.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":"t6i26p11iap2cp9k6cqro7.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-1690/docs/KeyboardFocusRegion.json b/pr-preview/pr-1690/docs/KeyboardFocusRegion.json index 048c900dc5..28f07b62e8 100644 --- a/pr-preview/pr-1690/docs/KeyboardFocusRegion.json +++ b/pr-preview/pr-1690/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":"x8k3qv4ngcmfk8tt6hgpz.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":"ze25iywd9o6tjdrxl24px.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-1690/docs/Locale.json b/pr-preview/pr-1690/docs/Locale.json index 26e1ae3065..5e8f544b93 100644 --- a/pr-preview/pr-1690/docs/Locale.json +++ b/pr-preview/pr-1690/docs/Locale.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n * Localization utilities\n * @module Locale\n */","meta":{"filename":"n18zr8wtc6e9qlmqzvedg.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":"usmw4nayvmarya2jsywhff.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-1690/docs/MenuContext.json b/pr-preview/pr-1690/docs/MenuContext.json index 68e6db34b3..136ff34b48 100644 --- a/pr-preview/pr-1690/docs/MenuContext.json +++ b/pr-preview/pr-1690/docs/MenuContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module MenuContext\n**/","meta":{"filename":"n83rg6tkadser1ij3vfovj.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":"o939vjbqm1a35jka8c879.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-1690/docs/PositionPropTypes.json b/pr-preview/pr-1690/docs/PositionPropTypes.json index 85e90f1c52..ad9ac3ccee 100644 --- a/pr-preview/pr-1690/docs/PositionPropTypes.json +++ b/pr-preview/pr-1690/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":"giqoal42hq9w58v69w6ky.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":"lzid9l9o351iwy18pcbhn.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-1690/docs/ProgressCircle.json b/pr-preview/pr-1690/docs/ProgressCircle.json index e0db337d4a..4e2aecb70c 100644 --- a/pr-preview/pr-1690/docs/ProgressCircle.json +++ b/pr-preview/pr-1690/docs/ProgressCircle.json @@ -1 +1 @@ -{"description":"\n`` is a 🍩 styled HTML `` element, complete\nwith the aria attributes required to support screen readers.\n\n### `size`, `shouldAnimateOnMount`, `animationDelay`\n\n```js\n---\ntype: example\n---\n

\n \n \n \n {valueNow}\n
\n / \n {valueMax}\n \n )\n }}\n />\n (valueMax / 2) ? 'pass' : 'fail'\n return `${valueNow} of ${valueMax}: ${passing}`\n }}\n renderValue={function ({ valueNow, valueMax }) {\n if (valueNow > (valueMax / 2)) {\n return (\n \n PASS\n \n )\n } else {\n return (\n \n FAIL\n \n )\n }\n }}\n />\n
\n```\n\n### `color`\n\n``'s `color` property controls the overall color scheme of the\ncomponent. Set it to `primary-inverse` when the component is used on dark backgrounds.\n\n```js\n---\ntype: example\n\n---\n\n \n\n```\n\n### `meterColor`\n\nThe color of the progress meter is set separately through the `meterColor` property.\n\n```js\n---\ntype: example\n---\n
\n \n \n \n \n \n
\n```\n\n`meterColor` can also be passed in as a function that takes `valueNow / valueMax`\nas parameters. This allows you to adjust the color of the meter based on the\ncurrent value.\n\n```js\n---\ntype: example\n---\n {\n if (valueNow < 20) {\n return 'danger'\n } else if (valueNow / valueMax >= 1) {\n return 'success'\n } else {\n return 'info'\n }\n }}\n valueNow={10}\n valueMax={60}\n/>\n```\n\n> `` defaults to setting the meter color to `success` when\n> complete.\n\n### `renderValue` / `formatScreenReaderValue`\n\nVia the `renderValue` prop, developers can use `valueMax` and `valueNow` props to format the\nvalue that `` displays.\n\n> `renderValue` will not be spoken by screen readers. Any essential information\n> in `renderValue` must also be conveyed via `formatScreenReaderValue` for screen reader users.\n\n```js\n---\ntype: example\n---\n {\n return Math.round((valueNow / valueMax * 100)) + ' percent'\n }}\n renderValue={({ valueNow, valueMax }) => {\n const percent = Math.round(valueNow / valueMax * 100)\n return (\n \n \n {percent > 100 ? 100 : percent}\n \n %\n \n )\n }}\n valueMax={88}\n valueNow={33}\n/>\n```\n","displayName":"ProgressCircle","methods":[],"props":{"screenReaderLabel":{"type":{"name":"string"},"required":true,"description":"A label is required for accessibility","tsType":{"name":"string"}},"size":{"type":{"name":"enum","value":[{"value":"'x-small'","computed":false},{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Control the size of the progress circle","tsType":{"name":"union","raw":"'x-small' | 'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'x-small'"},{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"valueMax":{"type":{"name":"number"},"required":false,"description":"Maximum value (defaults to 100)","tsType":{"name":"number","raw":"Values['valueMax']"},"defaultValue":{"value":"100","computed":false}},"valueNow":{"type":{"name":"number"},"required":false,"description":"Receives the progress of the event","tsType":{"name":"number","raw":"Values['valueNow']"},"defaultValue":{"value":"0","computed":false}},"formatScreenReaderValue":{"type":{"name":"func"},"required":false,"description":"A function for formatting the text provided to screen readers via `aria-valuenow`","tsType":{"name":"signature","type":"function","raw":"(values: Values) => string","signature":{"arguments":[{"type":{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}},"name":"values"}],"return":{"name":"string"}}},"defaultValue":{"value":"({ valueNow, valueMax }: Values) =>\n`${valueNow} / ${valueMax}`","computed":false}},"renderValue":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"A function to format the displayed value. If null the value will not display.\nTakes `valueNow` and `valueMax` as parameters.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}},{"name":"ClassicComponent","elements":[{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"color":{"type":{"name":"enum","value":[{"value":"'primary'","computed":false},{"value":"'primary-inverse'","computed":false}]},"required":false,"description":"Controls the overall color scheme of the component","tsType":{"name":"union","raw":"'primary' | 'primary-inverse'","elements":[{"name":"literal","value":"'primary'"},{"name":"literal","value":"'primary-inverse'"}]},"defaultValue":{"value":"'primary'","computed":false}},"meterColor":{"type":{"name":"union","value":[{"name":"func"},{"name":"enum","value":[{"value":"'info'","computed":false},{"value":"'warning'","computed":false},{"value":"'danger'","computed":false},{"value":"'alert'","computed":false},{"value":"'success'","computed":false},{"value":"'brand'","computed":false}]}]},"required":false,"description":"Control the color of the progress meter. Defaults to showing theme success\ncolor on completion, based on `valueNow` and `valueMax`.","tsType":{"name":"union","raw":"| ((values: Values) => ProgressCircleMeterColor)\n| ProgressCircleMeterColor","elements":[{"name":"unknown"},{"name":"union","raw":"| 'info'\n| 'warning'\n| 'danger'\n| 'alert'\n| 'success'\n| 'brand'","elements":[{"name":"literal","value":"'info'"},{"name":"literal","value":"'warning'"},{"name":"literal","value":"'danger'"},{"name":"literal","value":"'alert'"},{"name":"literal","value":"'success'"},{"name":"literal","value":"'brand'"}]}]},"defaultValue":{"value":"({ valueNow, valueMax }: Values) =>\nvalueNow / valueMax >= 1 ? 'success' : 'brand'","computed":false}},"margin":{"type":{"name":"custom","raw":"ThemeablePropTypes.spacing"},"required":false,"description":"Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,\n`small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via\nfamiliar CSS-like shorthand. For example: `margin=\"small auto large\"`.","tsType":{"name":"Spacing"}},"elementRef":{"type":{"name":"func"},"required":false,"description":"Provides a reference to the component's root HTML element","tsType":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"as":{"type":{"name":"elementType"},"required":false,"description":"Set the element type of the component's root","tsType":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}]},"defaultValue":{"value":"'div'","computed":false}},"shouldAnimateOnMount":{"type":{"name":"bool"},"required":false,"description":"","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"animationDelay":{"type":{"name":"number"},"required":false,"description":"","tsType":{"name":"number"}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-progress/src/ProgressCircle/index.tsx","extension":".tsx","srcPath":"packages/ui-progress/src/ProgressCircle/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-progress/src/ProgressCircle/index.tsx","packageName":"@instructure/ui-progress","requirePath":"@instructure/ui-progress/lib/ProgressCircle/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-progress/src/ProgressCircle/index.tsx').default","esPath":"@instructure/ui-progress/es/ProgressCircle/index","themePath":"packages/ui-progress/src/ProgressCircle/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-progress/src/ProgressCircle/theme.ts","id":"ProgressCircle","title":"ProgressCircle"} \ No newline at end of file +{"description":"\n`` is a 🍩 styled HTML `` element, complete\nwith the aria attributes required to support screen readers.\n\n### `size`, `shouldAnimateOnMount`, `animationDelay`\n\n```js\n---\ntype: example\n---\n

\n \n \n \n {valueNow}\n
\n / \n {valueMax}\n \n )\n }}\n />\n (valueMax / 2) ? 'pass' : 'fail'\n return `${valueNow} of ${valueMax}: ${passing}`\n }}\n renderValue={function ({ valueNow, valueMax }) {\n if (valueNow > (valueMax / 2)) {\n return (\n \n PASS\n \n )\n } else {\n return (\n \n FAIL\n \n )\n }\n }}\n />\n
\n```\n\n### `color`\n\n``'s `color` property controls the overall color scheme of the\ncomponent. Set it to `primary-inverse` when the component is used on dark backgrounds.\n\n```js\n---\ntype: example\n\n---\n\n \n\n```\n\n### `meterColor`\n\nThe color of the progress meter is set separately through the `meterColor` property.\n\n```js\n---\ntype: example\n---\n
\n \n \n \n \n \n
\n```\n\n`meterColor` can also be passed in as a function that takes `valueNow / valueMax`\nas parameters. This allows you to adjust the color of the meter based on the\ncurrent value.\n\n```js\n---\ntype: example\n---\n {\n if (valueNow < 20) {\n return 'danger'\n } else if (valueNow / valueMax >= 1) {\n return 'success'\n } else {\n return 'info'\n }\n }}\n valueNow={10}\n valueMax={60}\n/>\n```\n\n> `` defaults to setting the meter color to `success` when\n> complete.\n\n### `renderValue` / `formatScreenReaderValue`\n\nVia the `renderValue` prop, developers can use `valueMax` and `valueNow` props to format the\nvalue that `` displays.\n\n> `renderValue` will not be spoken by screen readers. Any essential information\n> in `renderValue` must also be conveyed via `formatScreenReaderValue` for screen reader users.\n\n```js\n---\ntype: example\n---\n {\n return Math.round((valueNow / valueMax * 100)) + ' percent'\n }}\n renderValue={({ valueNow, valueMax }) => {\n const percent = Math.round(valueNow / valueMax * 100)\n return (\n \n \n {percent > 100 ? 100 : percent}\n \n %\n \n )\n }}\n valueMax={88}\n valueNow={33}\n/>\n```\n","displayName":"ProgressCircle","methods":[],"props":{"screenReaderLabel":{"type":{"name":"string"},"required":true,"description":"A label is required for accessibility","tsType":{"name":"string"}},"size":{"type":{"name":"enum","value":[{"value":"'x-small'","computed":false},{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Control the size of the progress circle","tsType":{"name":"union","raw":"'x-small' | 'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'x-small'"},{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"valueMax":{"type":{"name":"number"},"required":false,"description":"Maximum value (defaults to 100)","tsType":{"name":"number","raw":"Values['valueMax']"},"defaultValue":{"value":"100","computed":false}},"valueNow":{"type":{"name":"number"},"required":false,"description":"Receives the progress of the event","tsType":{"name":"number","raw":"Values['valueNow']"},"defaultValue":{"value":"0","computed":false}},"formatScreenReaderValue":{"type":{"name":"func"},"required":false,"description":"A function for formatting the text provided to screen readers via `aria-valuenow`","tsType":{"name":"signature","type":"function","raw":"(values: Values) => string","signature":{"arguments":[{"type":{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}},"name":"values"}],"return":{"name":"string"}}},"defaultValue":{"value":"({ valueNow, valueMax }: Values) =>\n`${valueNow} / ${valueMax}`","computed":false}},"renderValue":{"type":{"name":"union","value":[{"name":"func"},{"name":"node"}]},"required":false,"description":"A function to format the displayed value. If null the value will not display.\nTakes `valueNow` and `valueMax` as parameters.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}},{"name":"ClassicComponent","elements":[{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"signature","type":"object","raw":"{ valueNow: number; valueMax: number }","signature":{"properties":[{"key":"valueNow","value":{"name":"number","required":true}},{"key":"valueMax","value":{"name":"number","required":true}}]}}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"color":{"type":{"name":"enum","value":[{"value":"'primary'","computed":false},{"value":"'primary-inverse'","computed":false}]},"required":false,"description":"Controls the overall color scheme of the component","tsType":{"name":"union","raw":"'primary' | 'primary-inverse'","elements":[{"name":"literal","value":"'primary'"},{"name":"literal","value":"'primary-inverse'"}]},"defaultValue":{"value":"'primary'","computed":false}},"meterColor":{"type":{"name":"union","value":[{"name":"func"},{"name":"enum","value":[{"value":"'info'","computed":false},{"value":"'warning'","computed":false},{"value":"'danger'","computed":false},{"value":"'alert'","computed":false},{"value":"'success'","computed":false},{"value":"'brand'","computed":false}]}]},"required":false,"description":"Control the color of the progress meter. Defaults to showing theme success\ncolor on completion, based on `valueNow` and `valueMax`.","tsType":{"name":"union","raw":"| ((values: Values) => ProgressCircleMeterColor)\n| ProgressCircleMeterColor","elements":[{"name":"unknown"},{"name":"union","raw":"| 'info'\n| 'warning'\n| 'danger'\n| 'alert'\n| 'success'\n| 'brand'","elements":[{"name":"literal","value":"'info'"},{"name":"literal","value":"'warning'"},{"name":"literal","value":"'danger'"},{"name":"literal","value":"'alert'"},{"name":"literal","value":"'success'"},{"name":"literal","value":"'brand'"}]}]},"defaultValue":{"value":"({ valueNow, valueMax }: Values) =>\nvalueNow / valueMax >= 1 ? 'success' : 'brand'","computed":false}},"margin":{"type":{"name":"custom","raw":"ThemeablePropTypes.spacing"},"required":false,"description":"Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,\n`small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via\nfamiliar CSS-like shorthand. For example: `margin=\"small auto large\"`.","tsType":{"name":"Spacing"}},"elementRef":{"type":{"name":"func"},"required":false,"description":"Provides a reference to the component's root HTML element","tsType":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"as":{"type":{"name":"elementType"},"required":false,"description":"Set the element type of the component's root","tsType":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}]},"defaultValue":{"value":"'div'","computed":false}},"shouldAnimateOnMount":{"type":{"name":"bool"},"required":false,"description":"","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"animationDelay":{"type":{"name":"number"},"required":false,"description":"","tsType":{"name":"number"}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-progress/src/ProgressCircle/index.tsx","extension":".tsx","srcPath":"packages/ui-progress/src/ProgressCircle/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-progress/src/ProgressCircle/index.tsx","packageName":"@instructure/ui-progress","requirePath":"@instructure/ui-progress/lib/ProgressCircle/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-progress/src/ProgressCircle/index.tsx').default","esPath":"@instructure/ui-progress/es/ProgressCircle/index","themePath":"packages/ui-progress/src/ProgressCircle/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-progress/src/ProgressCircle/theme.ts","id":"ProgressCircle","title":"ProgressCircle"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/ResponsivePropTypes.json b/pr-preview/pr-1690/docs/ResponsivePropTypes.json index e6138f25e2..ca3db51fed 100644 --- a/pr-preview/pr-1690/docs/ResponsivePropTypes.json +++ b/pr-preview/pr-1690/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":"knuzpfmkss2x2p7ze7m11.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":"djkpu4t7cmr6qujtbnapud.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-1690/docs/ScreenReaderFocusRegion.json b/pr-preview/pr-1690/docs/ScreenReaderFocusRegion.json index bcaaca2ab7..b1843dd6ee 100644 --- a/pr-preview/pr-1690/docs/ScreenReaderFocusRegion.json +++ b/pr-preview/pr-1690/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":"zr4hxa97yp9be3mt2emhz8.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":"l8kuvnpmqqpfc86y67mmr.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-1690/docs/SimpleSelect.json b/pr-preview/pr-1690/docs/SimpleSelect.json index c4d7d9a262..357d5f7b3e 100644 --- a/pr-preview/pr-1690/docs/SimpleSelect.json +++ b/pr-preview/pr-1690/docs/SimpleSelect.json @@ -1 +1 @@ -{"description":"\n`SimpleSelect` is a higher level abstraction of [Select](#Select) that closely parallels the functionality of standard HTML `` element, `SimpleSelect` supports option groups. `SimpleSelect.Group` only requires the `renderLabel` prop be provided.\n\n```javascript\n---\ntype: example\n---\n\n \n \n Option one\n \n \n \n \n Option two\n \n \n Option three\n \n \n Option four\n \n \n\n```\n\n### Icons\n\nTo display icons (or other elements) before or after an option, pass it via the `renderBeforeLabel` and `renderAfterLabel` prop to `SimpleSelect.Option`. You can pass a function as well, which will have a `props` parameter, so you can access the properties of that `SimpleSelect.Option` (e.g. if it is currently `isHighlighted`). The available props are: `[ id, isDisabled, isSelected, isHighlighted, children ]` (same as for `Select.Option`).\n\n```javascript\n---\ntype: example\n---\n\n \n Text\n \n }\n >\n Icon\n \n {\n let color = 'brand'\n if (props.isHighlighted) color = 'primary-inverse'\n if (props.isSelected) color = 'primary'\n if (props.isDisabled) color = 'warning'\n return \n }}\n >\n Colored Icon\n \n\n```\n\n> Note: This component uses a native `input` field to render the selected value. When it's included in a native HTML `form`, the text value will be sent to the backend instead of anything specified in the `value` field of the `SimpleSelect.Option`-s. We do not recommend to use this component this way, rather write your own code that collects information and sends it to the backend.\n","displayName":"SimpleSelect","methods":[],"props":{"renderLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"The form field label.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"value":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"The value corresponding to the value of the selected option. If defined,\nthe component will act controlled and will not manage its own state.","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]}},"defaultValue":{"type":{"name":"string"},"required":false,"description":"The value of the option to select by default, when uncontrolled.","tsType":{"name":"string"}},"id":{"type":{"name":"string"},"required":false,"description":"The id of the text input. One is generated if not supplied.","tsType":{"name":"string"}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"The size of the text input.","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"assistiveText":{"type":{"name":"string"},"required":false,"description":"Additional helpful text to provide to screen readers about the operation\nof the component. Provided via aria-describedby.","tsType":{"name":"string"}},"placeholder":{"type":{"name":"string"},"required":false,"description":"Html placeholder text to display when the input has no value. This should\nbe hint text, not a label replacement.","tsType":{"name":"string"}},"interaction":{"type":{"name":"enum","value":[{"value":"'enabled'","computed":false},{"value":"'disabled'","computed":false},{"value":"'readonly'","computed":false}]},"required":false,"description":"Specifies if interaction with the input is enabled, disabled, or readonly.\nWhen \"disabled\", the input changes visibly to indicate that it cannot\nreceive user interactions. When \"readonly\" the input still cannot receive\nuser interactions but it keeps the same styles as if it were enabled.","tsType":{"name":"union","raw":"'enabled' | 'disabled' | 'readonly'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"},{"name":"literal","value":"'readonly'"}]}},"isRequired":{"type":{"name":"bool"},"required":false,"description":"Whether or not the text input is required.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"isInline":{"type":{"name":"bool"},"required":false,"description":"Whether the input is rendered inline with other elements or if it\nis rendered as a block level element.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"The width of the text input.","tsType":{"name":"string"}},"visibleOptionsCount":{"type":{"name":"number"},"required":false,"description":"The number of options that should be visible before having to scroll. Works best when the options are the same height.","tsType":{"name":"number"},"defaultValue":{"value":"8","computed":false}},"optionsMaxHeight":{"type":{"name":"string"},"required":false,"description":"The max height the options list can be before having to scroll. If\nset, it will __override__ the `visibleOptionsCount` prop.","tsType":{"name":"string"}},"optionsMaxWidth":{"type":{"name":"string"},"required":false,"description":"The max width the options list can be before option text wraps. If not\nset, the list will only display as wide as the text input.","tsType":{"name":"string"}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Displays messages and validation for the input. It should be an array of\nobjects with the following shape:\n`{\n text: ReactNode,\n type: One of: ['error', 'hint', 'success', 'screenreader-only']\n}`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"placement":{"type":{"name":"custom","raw":"PositionPropTypes.placement"},"required":false,"description":"The placement of the options list.","tsType":{"name":"PlacementPropValues"},"defaultValue":{"value":"'bottom stretch'","computed":false}},"constrain":{"type":{"name":"custom","raw":"PositionPropTypes.constrain"},"required":false,"description":"The parent in which to constrain the placement.","tsType":{"name":"PositionConstraint"},"defaultValue":{"value":"'window'","computed":false}},"mountNode":{"type":{"name":"custom","raw":"PositionPropTypes.mountNode"},"required":false,"description":"An element or a function returning an element to use mount the options\nlist to in the DOM (defaults to `document.body`)","tsType":{"name":"PositionMountNode"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Callback fired when a new option is selected.","tsType":{"name":"signature","type":"function","raw":"(\n event: React.SyntheticEvent,\n data: {\n value?: string | number\n id?: string\n }\n) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{\n value?: string | number\n id?: string\n}","signature":{"properties":[{"key":"value","value":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}],"required":false}},{"key":"id","value":{"name":"string","required":false}}]}},"name":"data"}],"return":{"name":"void"}}}},"onFocus":{"type":{"name":"func"},"required":false,"description":"Callback fired when text input receives focus.","tsType":{"name":"signature","type":"function","raw":"(event: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"event"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Callback fired when text input loses focus.","tsType":{"name":"signature","type":"function","raw":"(event: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"event"}],"return":{"name":"void"}}}},"onShowOptions":{"type":{"name":"func"},"required":false,"description":"Callback fired when the options list is shown.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onHideOptions":{"type":{"name":"func"},"required":false,"description":"Callback fired when the options list is hidden.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"inputRef":{"type":{"name":"func"},"required":false,"description":"A ref to the html `input` element.","tsType":{"name":"signature","type":"function","raw":"(inputElement: HTMLInputElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLInputElement | null","elements":[{"name":"HTMLInputElement"},{"name":"null"}]},"name":"inputElement"}],"return":{"name":"void"}}}},"listRef":{"type":{"name":"func"},"required":false,"description":"A ref to the html `ul` element.","tsType":{"name":"signature","type":"function","raw":"(listElement: HTMLUListElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLUListElement | null","elements":[{"name":"HTMLUListElement"},{"name":"null"}]},"name":"listElement"}],"return":{"name":"void"}}}},"renderEmptyOption":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to display in the list when no options are available.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]},"defaultValue":{"value":"'---'","computed":false}},"renderBeforeInput":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to display before the text input. This will commonly be an icon.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderAfterInput":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to display after the text input. This content will replace the\ndefault arrow icons.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"children":{"type":{"name":"custom","raw":"ChildrenPropTypes.oneOf([Group, Option])"},"required":false,"description":"Children of type `` or ``.","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","tags":"form, field, dropdown","relativePath":"packages/ui-simple-select/src/SimpleSelect/index.tsx","extension":".tsx","srcPath":"packages/ui-simple-select/src/SimpleSelect/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-simple-select/src/SimpleSelect/index.tsx","packageName":"@instructure/ui-simple-select","requirePath":"@instructure/ui-simple-select/lib/SimpleSelect/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-simple-select/src/SimpleSelect/index.tsx').default","esPath":"@instructure/ui-simple-select/es/SimpleSelect/index","id":"SimpleSelect","title":"SimpleSelect"} \ No newline at end of file +{"description":"\n`SimpleSelect` is a higher level abstraction of [Select](#Select) that closely parallels the functionality of standard HTML `` element, `SimpleSelect` supports option groups. `SimpleSelect.Group` only requires the `renderLabel` prop be provided.\n\n```javascript\n---\ntype: example\n---\n\n \n \n Option one\n \n \n \n \n Option two\n \n \n Option three\n \n \n Option four\n \n \n\n```\n\n### Icons\n\nTo display icons (or other elements) before or after an option, pass it via the `renderBeforeLabel` and `renderAfterLabel` prop to `SimpleSelect.Option`. You can pass a function as well, which will have a `props` parameter, so you can access the properties of that `SimpleSelect.Option` (e.g. if it is currently `isHighlighted`). The available props are: `[ id, isDisabled, isSelected, isHighlighted, children ]` (same as for `Select.Option`).\n\n```javascript\n---\ntype: example\n---\n\n \n Text\n \n }\n >\n Icon\n \n {\n let color = 'brand'\n if (props.isHighlighted) color = 'primary-inverse'\n if (props.isSelected) color = 'primary'\n if (props.isDisabled) color = 'warning'\n return \n }}\n >\n Colored Icon\n \n\n```\n\n> Note: This component uses a native `input` field to render the selected value. When it's included in a native HTML `form`, the text value will be sent to the backend instead of anything specified in the `value` field of the `SimpleSelect.Option`-s. We do not recommend to use this component this way, rather write your own code that collects information and sends it to the backend.\n","displayName":"SimpleSelect","methods":[],"props":{"renderLabel":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"The form field label.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"value":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"The value corresponding to the value of the selected option. If defined,\nthe component will act controlled and will not manage its own state.","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]}},"defaultValue":{"type":{"name":"string"},"required":false,"description":"The value of the option to select by default, when uncontrolled.","tsType":{"name":"string"}},"id":{"type":{"name":"string"},"required":false,"description":"The id of the text input. One is generated if not supplied.","tsType":{"name":"string"}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"The size of the text input.","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"assistiveText":{"type":{"name":"string"},"required":false,"description":"Additional helpful text to provide to screen readers about the operation\nof the component. Provided via aria-describedby.","tsType":{"name":"string"}},"placeholder":{"type":{"name":"string"},"required":false,"description":"Html placeholder text to display when the input has no value. This should\nbe hint text, not a label replacement.","tsType":{"name":"string"}},"interaction":{"type":{"name":"enum","value":[{"value":"'enabled'","computed":false},{"value":"'disabled'","computed":false},{"value":"'readonly'","computed":false}]},"required":false,"description":"Specifies if interaction with the input is enabled, disabled, or readonly.\nWhen \"disabled\", the input changes visibly to indicate that it cannot\nreceive user interactions. When \"readonly\" the input still cannot receive\nuser interactions but it keeps the same styles as if it were enabled.","tsType":{"name":"union","raw":"'enabled' | 'disabled' | 'readonly'","elements":[{"name":"literal","value":"'enabled'"},{"name":"literal","value":"'disabled'"},{"name":"literal","value":"'readonly'"}]}},"isRequired":{"type":{"name":"bool"},"required":false,"description":"Whether or not the text input is required.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"isInline":{"type":{"name":"bool"},"required":false,"description":"Whether the input is rendered inline with other elements or if it\nis rendered as a block level element.","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"width":{"type":{"name":"string"},"required":false,"description":"The width of the text input.","tsType":{"name":"string"}},"visibleOptionsCount":{"type":{"name":"number"},"required":false,"description":"The number of options that should be visible before having to scroll. Works best when the options are the same height.","tsType":{"name":"number"},"defaultValue":{"value":"8","computed":false}},"optionsMaxHeight":{"type":{"name":"string"},"required":false,"description":"The max height the options list can be before having to scroll. If\nset, it will __override__ the `visibleOptionsCount` prop.","tsType":{"name":"string"}},"optionsMaxWidth":{"type":{"name":"string"},"required":false,"description":"The max width the options list can be before option text wraps. If not\nset, the list will only display as wide as the text input.","tsType":{"name":"string"}},"messages":{"type":{"name":"arrayOf","value":{"name":"custom","raw":"FormPropTypes.message"}},"required":false,"description":"Displays messages and validation for the input. It should be an array of\nobjects with the following shape:\n`{\n text: ReactNode,\n type: One of: ['error', 'hint', 'success', 'screenreader-only']\n}`","tsType":{"name":"Array","elements":[{"name":"FormMessage"}],"raw":"FormMessage[]"}},"placement":{"type":{"name":"custom","raw":"PositionPropTypes.placement"},"required":false,"description":"The placement of the options list.","tsType":{"name":"PlacementPropValues"},"defaultValue":{"value":"'bottom stretch'","computed":false}},"constrain":{"type":{"name":"custom","raw":"PositionPropTypes.constrain"},"required":false,"description":"The parent in which to constrain the placement.","tsType":{"name":"PositionConstraint"},"defaultValue":{"value":"'window'","computed":false}},"mountNode":{"type":{"name":"custom","raw":"PositionPropTypes.mountNode"},"required":false,"description":"An element or a function returning an element to use mount the options\nlist to in the DOM (defaults to `document.body`)","tsType":{"name":"PositionMountNode"}},"onChange":{"type":{"name":"func"},"required":false,"description":"Callback fired when a new option is selected.","tsType":{"name":"signature","type":"function","raw":"(\n event: React.SyntheticEvent,\n data: {\n value?: string | number\n id?: string\n }\n) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{\n value?: string | number\n id?: string\n}","signature":{"properties":[{"key":"value","value":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}],"required":false}},{"key":"id","value":{"name":"string","required":false}}]}},"name":"data"}],"return":{"name":"void"}}}},"onFocus":{"type":{"name":"func"},"required":false,"description":"Callback fired when text input receives focus.","tsType":{"name":"signature","type":"function","raw":"(event: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"event"}],"return":{"name":"void"}}}},"onBlur":{"type":{"name":"func"},"required":false,"description":"Callback fired when text input loses focus.","tsType":{"name":"signature","type":"function","raw":"(event: React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"ReactFocusEvent","raw":"React.FocusEvent","elements":[{"name":"HTMLInputElement"}]},"name":"event"}],"return":{"name":"void"}}}},"onShowOptions":{"type":{"name":"func"},"required":false,"description":"Callback fired when the options list is shown.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"onHideOptions":{"type":{"name":"func"},"required":false,"description":"Callback fired when the options list is hidden.","tsType":{"name":"signature","type":"function","raw":"(event: React.SyntheticEvent) => void","signature":{"arguments":[{"type":{"name":"ReactSyntheticEvent","raw":"React.SyntheticEvent"},"name":"event"}],"return":{"name":"void"}}}},"inputRef":{"type":{"name":"func"},"required":false,"description":"A ref to the html `input` element.","tsType":{"name":"signature","type":"function","raw":"(inputElement: HTMLInputElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLInputElement | null","elements":[{"name":"HTMLInputElement"},{"name":"null"}]},"name":"inputElement"}],"return":{"name":"void"}}}},"listRef":{"type":{"name":"func"},"required":false,"description":"A ref to the html `ul` element.","tsType":{"name":"signature","type":"function","raw":"(listElement: HTMLUListElement | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"HTMLUListElement | null","elements":[{"name":"HTMLUListElement"},{"name":"null"}]},"name":"listElement"}],"return":{"name":"void"}}}},"renderEmptyOption":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to display in the list when no options are available.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]},"defaultValue":{"value":"'---'","computed":false}},"renderBeforeInput":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to display before the text input. This will commonly be an icon.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"renderAfterInput":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":false,"description":"Content to display after the text input. This content will replace the\ndefault arrow icons.","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"children":{"type":{"name":"custom","raw":"ChildrenPropTypes.oneOf([Group, Option])"},"required":false,"description":"Children of type `` or ``.","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","tags":"form, field, dropdown","relativePath":"packages/ui-simple-select/src/SimpleSelect/index.tsx","extension":".tsx","srcPath":"packages/ui-simple-select/src/SimpleSelect/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-simple-select/src/SimpleSelect/index.tsx","packageName":"@instructure/ui-simple-select","requirePath":"@instructure/ui-simple-select/lib/SimpleSelect/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-simple-select/src/SimpleSelect/index.tsx').default","esPath":"@instructure/ui-simple-select/es/SimpleSelect/index","id":"SimpleSelect","title":"SimpleSelect"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/TextDirectionContext.json b/pr-preview/pr-1690/docs/TextDirectionContext.json index c83e362f27..3b27beb117 100644 --- a/pr-preview/pr-1690/docs/TextDirectionContext.json +++ b/pr-preview/pr-1690/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":"65xor5fhu0ukq0720306a.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":"zyv65qydgvhg7abckvlr4.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-1690/docs/ThemeRegistry.json b/pr-preview/pr-1690/docs/ThemeRegistry.json index b094716674..1ca41df4c3 100644 --- a/pr-preview/pr-1690/docs/ThemeRegistry.json +++ b/pr-preview/pr-1690/docs/ThemeRegistry.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * A global theme registry used for registering theme objects, setting globally available themes\n * and receiving the currently used theme.\n * @module ThemeRegistry\n */","meta":{"filename":"5boqapp17oj2kwkub8yqa2.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A global theme registry used for registering theme objects, setting globally available themes\nand receiving the currently used theme.","kind":"module","name":"ThemeRegistry","longname":"module:ThemeRegistry","undocumented":false,"category":"utilities/themes","relativePath":"packages/theme-registry/src/ThemeRegistry.ts","extension":".ts","srcPath":"packages/theme-registry/src/ThemeRegistry.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","packageName":"@instructure/theme-registry","requirePath":"@instructure/theme-registry/lib/ThemeRegistry","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/theme-registry/src/ThemeRegistry.ts').default","esPath":"@instructure/theme-registry/es/ThemeRegistry","themePath":"packages/theme-registry/src/ThemeRegistry.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","id":"ThemeRegistry","title":"ThemeRegistry"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * A global theme registry used for registering theme objects, setting globally available themes\n * and receiving the currently used theme.\n * @module ThemeRegistry\n */","meta":{"filename":"kr45sb61s3sqhp58f062vp.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A global theme registry used for registering theme objects, setting globally available themes\nand receiving the currently used theme.","kind":"module","name":"ThemeRegistry","longname":"module:ThemeRegistry","undocumented":false,"category":"utilities/themes","relativePath":"packages/theme-registry/src/ThemeRegistry.ts","extension":".ts","srcPath":"packages/theme-registry/src/ThemeRegistry.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","packageName":"@instructure/theme-registry","requirePath":"@instructure/theme-registry/lib/ThemeRegistry","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/theme-registry/src/ThemeRegistry.ts').default","esPath":"@instructure/theme-registry/es/ThemeRegistry","themePath":"packages/theme-registry/src/ThemeRegistry.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/theme-registry/src/ThemeRegistry.ts","id":"ThemeRegistry","title":"ThemeRegistry"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/ThemeablePropTypes.json b/pr-preview/pr-1690/docs/ThemeablePropTypes.json index 5143d595c6..6eda63f2e9 100644 --- a/pr-preview/pr-1690/docs/ThemeablePropTypes.json +++ b/pr-preview/pr-1690/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":"jtvic0mo0w1m4efeeidkp.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":"82gsbgyoyzb8y45w7fqo65.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-1690/docs/ToggleDetails.json b/pr-preview/pr-1690/docs/ToggleDetails.json index 84b9a53b8c..f4da74f21b 100644 --- a/pr-preview/pr-1690/docs/ToggleDetails.json +++ b/pr-preview/pr-1690/docs/ToggleDetails.json @@ -1 +1 @@ -{"description":"\nThe ToggleDetails component can be used to show/hide content in response to user action.\n\nBy default, ToggleDetails content is hidden. To override, pass in the `defaultExpanded` prop.\n\n```js\n---\ntype: example\n---\n\n I am expanded! {lorem.paragraph()}\n\n```\n\nToggleDetails can be controlled:\n\n```js\n---\ntype: example\n---\n\nclass Example extends React.Component {\n state = {\n expanded: true\n };\n\n handleChange = (event, expanded) => this.setState({ expanded });\n\n handleToggle = () => this.setState({ expanded: !this.state.expanded });\n\n render () {\n return (\n

\n \n
\n
\n \n I am controlled and expanded! {lorem.paragraph()}\n \n
\n )\n }\n}\n\nrender()\n```\n\nSetting ToggleDetails to `filled` will make the toggle use a full-width [Button](#Button) component.\n\n```js\n---\ntype: example\n---\n\n {lorem.paragraph()}\n\n```\n\n### Icon size / summary text formatting\n\nIcon size can be adjusted using the `size` prop with small, medium, and large options.\n\nThe `summary` prop accepts any node, allowing you to format the summary text as\nyou see fit. In these examples, we are formatting it with the\n[Text](#Text) component.\n\n```js\n---\ntype: example\n---\n
\n \n {lorem.paragraph()}\n \n\n
\n\n \n {lorem.paragraph()}\n \n\n
\n\n \n {lorem.paragraph()}\n \n
\n```\n\n### Icon positioning and block display\n\nThe `iconPosition` prop determines if the icon comes before or after the summary.\n\nWhen the `fluidWidth` prop is set, the toggle fills the width of its\ncontainer.\n\n```js\n---\ntype: example\n---\n\n \n {lorem.paragraph()}\n \n\n```\n\n### Example to demonstrate more properties\n\n```js\n---\ntype: example\n---\nconst Example = () => {\n const [state, setState] = useState({\n expanded: true,\n fluidWidth: true,\n iconPosition: 'start',\n size: 'small',\n variant: 'default'\n });\n\n const handleChange = (field, value) => setState(prevState => ({ ...prevState, [field]: value }));\n const handleToggle = () => setState(prevState => ({ ...prevState, expanded: !prevState.expanded }));\n\n const renderOptions = () => {\n const { fluidWidth, iconPosition, size, variant } = state;\n const options = [\n { name: 'iconPosition', values: ['start', 'end'] },\n { name: 'size', values: ['small', 'medium', 'large'] },\n { name: 'variant', values: ['default', 'filled'] },\n ];\n\n return (\n \n {options.map(({ name, values }) => (\n \n handleChange(name, value)}\n >\n {values.map(val => (\n \n ))}\n \n \n ))}\n \n handleChange('fluidWidth', !fluidWidth)}\n />\n \n \n );\n };\n\n const { expanded, iconPosition, size, variant, fluidWidth } = state;\n\n return (\n
\n {renderOptions()}\n \n
\n
\n handleChange('expanded', expanded)}\n fluidWidth={fluidWidth}\n iconPosition={iconPosition}\n size={size}\n variant={variant}\n >\n \n I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!\n \n \n
\n );\n};\n\nrender()\n```\n\n### Guidelines\n\n```js\n---\ntype: embed\n---\n\n
\n Use ToggleDetails when descriptive text is longer than a short phrase\n
\n
\n Nest ToggleDetails within another ToggleDetails\n
\n\n```\n","displayName":"ToggleDetails","methods":[],"props":{"variant":{"type":{"name":"enum","value":[{"value":"'default'","computed":false},{"value":"'filled'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'default' | 'filled'","elements":[{"name":"literal","value":"'default'"},{"name":"literal","value":"'filled'"}]},"defaultValue":{"value":"'default'","computed":false}},"summary":{"type":{"name":"node"},"required":true,"description":"The summary that displays and can be interacted with","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"}},"expanded":{"type":{"name":"custom","raw":"controllable(PropTypes.bool, 'onToggle', 'defaultExpanded')"},"required":false,"description":"Whether the content is expanded or hidden","tsType":{"name":"boolean"}},"defaultExpanded":{"type":{"name":"bool"},"required":false,"description":"Whether the content is initially expanded or hidden (uncontrolled)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"onToggle":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(event: React.MouseEvent, expanded: boolean) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"event"},{"type":{"name":"boolean"},"name":"expanded"}],"return":{"name":"void"}}}},"icon":{"type":{"name":"func"},"required":false,"description":"The icon to display next to the summary text when content is hidden","tsType":{"name":"signature","type":"function","raw":"(...args: any[]) => React.ReactElement","signature":{"arguments":[{"type":{"name":"Array","elements":[{"name":"any"}],"raw":"any[]"},"name":"args","rest":true}],"return":{"name":"ReactReactElement","raw":"React.ReactElement"}}},"defaultValue":{"value":"IconArrowOpenEndSolid","computed":true}},"iconExpanded":{"type":{"name":"func"},"required":false,"description":"The icon to display when content is expanded","tsType":{"name":"signature","type":"function","raw":"(...args: any[]) => React.ReactElement","signature":{"arguments":[{"type":{"name":"Array","elements":[{"name":"any"}],"raw":"any[]"},"name":"args","rest":true}],"return":{"name":"ReactReactElement","raw":"React.ReactElement"}}},"defaultValue":{"value":"IconArrowOpenDownSolid","computed":true}},"iconPosition":{"type":{"name":"enum","value":[{"value":"'start'","computed":false},{"value":"'end'","computed":false}]},"required":false,"description":"Icon position at the start or end of the summary text","tsType":{"name":"union","raw":"'start' | 'end'","elements":[{"name":"literal","value":"'start'"},{"name":"literal","value":"'end'"}]},"defaultValue":{"value":"'start'","computed":false}},"fluidWidth":{"type":{"name":"bool"},"required":false,"description":"should the summary fill the width of its container","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"children":{"type":{"name":"node"},"required":false,"description":"The toggleable content passed inside the ToggleDetails component","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"},"defaultValue":{"value":"null","computed":false}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Choose a size for the expand/collapse icon","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-toggle-details/src/ToggleDetails/index.tsx","extension":".tsx","srcPath":"packages/ui-toggle-details/src/ToggleDetails/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-toggle-details/src/ToggleDetails/index.tsx","packageName":"@instructure/ui-toggle-details","requirePath":"@instructure/ui-toggle-details/lib/ToggleDetails/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-toggle-details/src/ToggleDetails/index.tsx').default","esPath":"@instructure/ui-toggle-details/es/ToggleDetails/index","themePath":"packages/ui-toggle-details/src/ToggleDetails/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-toggle-details/src/ToggleDetails/theme.ts","id":"ToggleDetails","title":"ToggleDetails"} \ No newline at end of file +{"description":"\nThe ToggleDetails component can be used to show/hide content in response to user action.\n\nBy default, ToggleDetails content is hidden. To override, pass in the `defaultExpanded` prop.\n\n```js\n---\ntype: example\n---\n\n I am expanded! {lorem.paragraph()}\n\n```\n\nToggleDetails can be controlled:\n\n- ```js\n class Example extends React.Component {\n state = {\n expanded: true\n }\n\n handleChange = (event, expanded) => this.setState({ expanded })\n\n handleToggle = () => this.setState({ expanded: !this.state.expanded })\n\n render() {\n return (\n
\n \n
\n
\n \n I am controlled and expanded!{' '}\n {lorem.paragraph()}\n \n
\n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [expanded, setExpanded] = useState(true)\n\n const handleChange = (event, expanded) => {\n setExpanded(expanded)\n }\n\n const handleToggle = () => {\n setExpanded((prevExpanded) => !prevExpanded)\n }\n\n return (\n
\n \n
\n
\n \n I am controlled and expanded!\n {lorem.paragraph()}\n \n
\n )\n }\n\n render()\n ```\n\nSetting ToggleDetails to `filled` will make the toggle use a full-width [Button](#Button) component.\n\n```js\n---\ntype: example\n---\n\n {lorem.paragraph()}\n\n```\n\n### Icon size / summary text formatting\n\nIcon size can be adjusted using the `size` prop with small, medium, and large options.\n\nThe `summary` prop accepts any node, allowing you to format the summary text as\nyou see fit. In these examples, we are formatting it with the\n[Text](#Text) component.\n\n```js\n---\ntype: example\n---\n
\n \n {lorem.paragraph()}\n \n\n
\n\n \n {lorem.paragraph()}\n \n\n
\n\n \n {lorem.paragraph()}\n \n
\n```\n\n### Icon positioning and block display\n\nThe `iconPosition` prop determines if the icon comes before or after the summary.\n\nWhen the `fluidWidth` prop is set, the toggle fills the width of its\ncontainer.\n\n```js\n---\ntype: example\n---\n\n \n {lorem.paragraph()}\n \n\n```\n\n### Example to demonstrate more properties\n\n```js\n---\ntype: example\n---\nconst Example = () => {\n const [state, setState] = useState({\n expanded: true,\n fluidWidth: true,\n iconPosition: 'start',\n size: 'small',\n variant: 'default'\n });\n\n const handleChange = (field, value) => setState(prevState => ({ ...prevState, [field]: value }));\n const handleToggle = () => setState(prevState => ({ ...prevState, expanded: !prevState.expanded }));\n\n const renderOptions = () => {\n const { fluidWidth, iconPosition, size, variant } = state;\n const options = [\n { name: 'iconPosition', values: ['start', 'end'] },\n { name: 'size', values: ['small', 'medium', 'large'] },\n { name: 'variant', values: ['default', 'filled'] },\n ];\n\n return (\n \n {options.map(({ name, values }) => (\n \n handleChange(name, value)}\n >\n {values.map(val => (\n \n ))}\n \n \n ))}\n \n handleChange('fluidWidth', !fluidWidth)}\n />\n \n \n );\n };\n\n const { expanded, iconPosition, size, variant, fluidWidth } = state;\n\n return (\n
\n {renderOptions()}\n \n
\n
\n handleChange('expanded', expanded)}\n fluidWidth={fluidWidth}\n iconPosition={iconPosition}\n size={size}\n variant={variant}\n >\n \n I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!I am controlled and expanded!\n \n \n
\n );\n};\n\nrender()\n```\n\n### Guidelines\n\n```js\n---\ntype: embed\n---\n\n
\n Use ToggleDetails when descriptive text is longer than a short phrase\n
\n
\n Nest ToggleDetails within another ToggleDetails\n
\n\n```\n","displayName":"ToggleDetails","methods":[],"props":{"variant":{"type":{"name":"enum","value":[{"value":"'default'","computed":false},{"value":"'filled'","computed":false}]},"required":false,"description":"","tsType":{"name":"union","raw":"'default' | 'filled'","elements":[{"name":"literal","value":"'default'"},{"name":"literal","value":"'filled'"}]},"defaultValue":{"value":"'default'","computed":false}},"summary":{"type":{"name":"node"},"required":true,"description":"The summary that displays and can be interacted with","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"}},"expanded":{"type":{"name":"custom","raw":"controllable(PropTypes.bool, 'onToggle', 'defaultExpanded')"},"required":false,"description":"Whether the content is expanded or hidden","tsType":{"name":"boolean"}},"defaultExpanded":{"type":{"name":"bool"},"required":false,"description":"Whether the content is initially expanded or hidden (uncontrolled)","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"onToggle":{"type":{"name":"func"},"required":false,"description":"","tsType":{"name":"signature","type":"function","raw":"(event: React.MouseEvent, expanded: boolean) => void","signature":{"arguments":[{"type":{"name":"ReactMouseEvent","raw":"React.MouseEvent"},"name":"event"},{"type":{"name":"boolean"},"name":"expanded"}],"return":{"name":"void"}}}},"icon":{"type":{"name":"func"},"required":false,"description":"The icon to display next to the summary text when content is hidden","tsType":{"name":"signature","type":"function","raw":"(...args: any[]) => React.ReactElement","signature":{"arguments":[{"type":{"name":"Array","elements":[{"name":"any"}],"raw":"any[]"},"name":"args","rest":true}],"return":{"name":"ReactReactElement","raw":"React.ReactElement"}}},"defaultValue":{"value":"IconArrowOpenEndSolid","computed":true}},"iconExpanded":{"type":{"name":"func"},"required":false,"description":"The icon to display when content is expanded","tsType":{"name":"signature","type":"function","raw":"(...args: any[]) => React.ReactElement","signature":{"arguments":[{"type":{"name":"Array","elements":[{"name":"any"}],"raw":"any[]"},"name":"args","rest":true}],"return":{"name":"ReactReactElement","raw":"React.ReactElement"}}},"defaultValue":{"value":"IconArrowOpenDownSolid","computed":true}},"iconPosition":{"type":{"name":"enum","value":[{"value":"'start'","computed":false},{"value":"'end'","computed":false}]},"required":false,"description":"Icon position at the start or end of the summary text","tsType":{"name":"union","raw":"'start' | 'end'","elements":[{"name":"literal","value":"'start'"},{"name":"literal","value":"'end'"}]},"defaultValue":{"value":"'start'","computed":false}},"fluidWidth":{"type":{"name":"bool"},"required":false,"description":"should the summary fill the width of its container","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"children":{"type":{"name":"node"},"required":false,"description":"The toggleable content passed inside the ToggleDetails component","tsType":{"name":"ReactReactNode","raw":"React.ReactNode"},"defaultValue":{"value":"null","computed":false}},"size":{"type":{"name":"enum","value":[{"value":"'small'","computed":false},{"value":"'medium'","computed":false},{"value":"'large'","computed":false}]},"required":false,"description":"Choose a size for the expand/collapse icon","tsType":{"name":"union","raw":"'small' | 'medium' | 'large'","elements":[{"name":"literal","value":"'small'"},{"name":"literal","value":"'medium'"},{"name":"literal","value":"'large'"}]},"defaultValue":{"value":"'medium'","computed":false}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-toggle-details/src/ToggleDetails/index.tsx","extension":".tsx","srcPath":"packages/ui-toggle-details/src/ToggleDetails/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-toggle-details/src/ToggleDetails/index.tsx","packageName":"@instructure/ui-toggle-details","requirePath":"@instructure/ui-toggle-details/lib/ToggleDetails/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-toggle-details/src/ToggleDetails/index.tsx').default","esPath":"@instructure/ui-toggle-details/es/ToggleDetails/index","themePath":"packages/ui-toggle-details/src/ToggleDetails/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-toggle-details/src/ToggleDetails/theme.ts","id":"ToggleDetails","title":"ToggleDetails"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/Tooltip.json b/pr-preview/pr-1690/docs/Tooltip.json index ac5e543cc7..81bc874893 100644 --- a/pr-preview/pr-1690/docs/Tooltip.json +++ b/pr-preview/pr-1690/docs/Tooltip.json @@ -1 +1 @@ -{"description":"\nTooltips are small text-only contextual overlays that are triggered by hover/focus. Use anywhere additional explanation might be needed but space is limited on the triggering element.\n\n> ### What about 'focusable' elements?\n>\n> Content provided to the `renderTip` prop **should not contain any focusable elements**. If you'd like to do\n> that you should use the [Popover](#Popover) component and handle focus management yourself or\n> consider using a [Modal](#Modal) or a [Tray](#Tray) as those will work better on smaller screens.\n\n#### Uncontrolled Tooltips\n\n```js\n---\ntype: example\n---\n
\n

\n console.log('showing')}\n onHideContent={() => console.log('hidden')}\n >\n Hover or focus me\n \n

\n

\n \n \n \n

\n

\n \n \n \n

\n
\n```\n\n#### Controlled Tooltips\n\n```js\n---\ntype: example\n---\nclass Example extends React.Component {\n constructor (props) {\n super(props)\n\n this.state = {\n isShowingContent: false\n }\n }\n\n render () {\n return (\n <>\n

\n {\n console.log(\"expecting to show tooltip\")\n }}\n onHideContent={(e) => {\n console.log(\"expecting to hide tooltip\")\n }}\n >\n This link has a tooltip\n \n

\n {\n this.setState({isShowingContent: event.target.checked})\n }}\n />\n \n )\n }\n}\n\nrender()\n```\n\n### Custom elements as renderTrigger\n\nPopover and Tooltip attach mouse and focus event listeners to their render trigger components via props. These need to be propagated to the component for the listeners to work:\n\n```js\n---\n type: example\n---\nclass MyComponent extends React.Component {\n constructor(props) {\n super(props)\n this.ref = React.createRef()\n }\n render() {\n // Spread the props to the underlying DOM element\n return
My custom component
\n }\n}\n\n \n\n```\n\n### Guidelines\n\n```js\n---\ntype: embed\n---\n\n
\n Use on icons with no labels\n Use on condensed dates\n Use on table content if items are getting truncated\n Use to provide more specific data (ie. user hovers over a chart element, Tooltip shows precise info)\n Try to stay within 50 characters\n
\n
\n Repeat the exact information contained on the triggering element\n Contain links or focusable items\n Use icons inside Tooltips\n Use in place of a Popover or Menu\n
\n\n```\n","displayName":"Tooltip","methods":[],"props":{"elementRef":{"type":{"name":"func"},"required":false,"description":"provides a reference to the underlying html root element","tsType":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"children":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"A ReactNode or a function that returns a ReactNode with the following params:\n\n@param {Boolean} focused - Is the Tooltip trigger focused?\n@param {Function} getTriggerProps - Props to be spread onto the trigger element","tsType":{"name":"union","raw":"React.ReactNode | TooltipRenderChildren","elements":[{"name":"ReactReactNode","raw":"React.ReactNode"},{"name":"signature","type":"function","raw":"(\n args: TooltipRenderChildrenArgs\n) => React.ReactNode","signature":{"arguments":[{"type":{"name":"signature","type":"object","raw":"{\n focused: boolean\n getTriggerProps: >(\n props: TriggerProps\n ) => { 'aria-describedby': string } & TriggerProps\n}","signature":{"properties":[{"key":"focused","value":{"name":"boolean","required":true}},{"key":"getTriggerProps","value":{"name":"signature","type":"function","raw":">(\n props: TriggerProps\n) => { 'aria-describedby': string } & TriggerProps","signature":{"arguments":[{"type":{"name":"TriggerProps"},"name":"props"}],"return":{"name":"intersection","raw":"{ 'aria-describedby': string } & TriggerProps","elements":[{"name":"signature","type":"object","raw":"{ 'aria-describedby': string }","signature":{"properties":[{"key":"aria-describedby","value":{"name":"string","required":true}}]}},{"name":"TriggerProps"}]}},"required":true}}]}},"name":"args"}],"return":{"name":"ReactReactNode","raw":"React.ReactNode"}}}]}},"renderTip":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"The content to render in the tooltip","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"isShowingContent":{"type":{"name":"bool"},"required":false,"description":"Whether or not the tooltip content is shown, when controlled","tsType":{"name":"boolean"}},"defaultIsShowingContent":{"type":{"name":"bool"},"required":false,"description":"Whether or not to show the content by default, when uncontrolled","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"as":{"type":{"name":"elementType"},"required":false,"description":"the element type to render as (assumes a single child if 'as' is undefined)","tsType":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}]}},"on":{"type":{"name":"union","value":[{"name":"enum","value":[{"value":"'click'","computed":false},{"value":"'hover'","computed":false},{"value":"'focus'","computed":false}]},{"name":"arrayOf","value":{"name":"enum","value":[{"value":"'click'","computed":false},{"value":"'hover'","computed":false},{"value":"'focus'","computed":false}]}}]},"required":false,"description":"The action that causes the Content to display (`click`, `hover`, `focus`)","tsType":{"name":"union","raw":"('click' | 'hover' | 'focus') | ('click' | 'hover' | 'focus')[]","elements":[{"name":"unknown"},{"name":"Array","elements":[{"name":"unknown"}],"raw":"('click' | 'hover' | 'focus')[]"}]}},"color":{"type":{"name":"enum","value":[{"value":"'primary'","computed":false},{"value":"'primary-inverse'","computed":false}]},"required":false,"description":"The color of the tooltip content","tsType":{"name":"union","raw":"'primary' | 'primary-inverse'","elements":[{"name":"literal","value":"'primary'"},{"name":"literal","value":"'primary-inverse'"}]},"defaultValue":{"value":"'primary'","computed":false}},"placement":{"type":{"name":"custom","raw":"PositionPropTypes.placement"},"required":false,"description":"Specifies where the Tooltip will be placed in relation to the target element.\nEx. placement=\"bottom\" will render the Tooltip below the triggering element\n(Note: if there is not room, it will position opposite. Ex. \"top\" will\nautomatically switch to \"bottom\")","tsType":{"name":"PlacementPropValues"},"defaultValue":{"value":"'top'","computed":false}},"mountNode":{"type":{"name":"custom","raw":"PositionPropTypes.mountNode"},"required":false,"description":"An element or a function returning an element to use as the mount node\nfor the `` (defaults to `document.body`)","tsType":{"name":"PositionMountNode"}},"constrain":{"type":{"name":"custom","raw":"PositionPropTypes.constrain"},"required":false,"description":"The parent in which to constrain the tooltip.\nOne of: 'window', 'scroll-parent', 'parent', 'none', an element,\nor a function returning an element","tsType":{"name":"PositionConstraint"},"defaultValue":{"value":"'window'","computed":false}},"offsetX":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"The horizontal offset for the positioned content","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]},"defaultValue":{"value":"0","computed":false}},"offsetY":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"The vertical offset for the positioned content","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]},"defaultValue":{"value":"0","computed":false}},"positionTarget":{"type":{"name":"union","value":[{"name":"element"},{"name":"func"}]},"required":false,"description":"Target element for positioning the Tooltip (if it differs from children/trigger)","tsType":{"name":"PositionMountNode"}},"onShowContent":{"type":{"name":"func"},"required":false,"description":"Callback fired when content is shown. When controlled, this callback is\nfired when the tooltip expects to be shown","tsType":{"name":"signature","type":"function","raw":"(event: React.UIEvent | React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"union","raw":"React.UIEvent | React.FocusEvent","elements":[{"name":"ReactUIEvent","raw":"React.UIEvent"},{"name":"ReactFocusEvent","raw":"React.FocusEvent"}]},"name":"event"}],"return":{"name":"void"}}}},"onHideContent":{"type":{"name":"func"},"required":false,"description":"Callback fired when content is hidden. When controlled, this callback is\nfired when the tooltip expects to be hidden","tsType":{"name":"signature","type":"function","raw":"(\n event: React.UIEvent | React.FocusEvent,\n args: { documentClick: boolean }\n) => void","signature":{"arguments":[{"type":{"name":"union","raw":"React.UIEvent | React.FocusEvent","elements":[{"name":"ReactUIEvent","raw":"React.UIEvent"},{"name":"ReactFocusEvent","raw":"React.FocusEvent"}]},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ documentClick: boolean }","signature":{"properties":[{"key":"documentClick","value":{"name":"boolean","required":true}}]}},"name":"args"}],"return":{"name":"void"}}}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-tooltip/src/Tooltip/index.tsx","extension":".tsx","srcPath":"packages/ui-tooltip/src/Tooltip/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-tooltip/src/Tooltip/index.tsx","packageName":"@instructure/ui-tooltip","requirePath":"@instructure/ui-tooltip/lib/Tooltip/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-tooltip/src/Tooltip/index.tsx').default","esPath":"@instructure/ui-tooltip/es/Tooltip/index","themePath":"packages/ui-tooltip/src/Tooltip/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-tooltip/src/Tooltip/theme.ts","id":"Tooltip","title":"Tooltip"} \ No newline at end of file +{"description":"\nTooltips are small text-only contextual overlays that are triggered by hover/focus. Use anywhere additional explanation might be needed but space is limited on the triggering element.\n\n> ### What about 'focusable' elements?\n>\n> Content provided to the `renderTip` prop **should not contain any focusable elements**. If you'd like to do\n> that you should use the [Popover](#Popover) component and handle focus management yourself or\n> consider using a [Modal](#Modal) or a [Tray](#Tray) as those will work better on smaller screens.\n\n#### Uncontrolled Tooltips\n\n```js\n---\ntype: example\n---\n

\n

\n console.log('showing')}\n onHideContent={() => console.log('hidden')}\n >\n Hover or focus me\n \n

\n

\n \n \n \n

\n

\n \n \n \n

\n
\n```\n\n#### Controlled Tooltips\n\n- ```js\n class Example extends React.Component {\n constructor(props) {\n super(props)\n\n this.state = {\n isShowingContent: false\n }\n }\n\n render() {\n return (\n <>\n

\n {\n console.log('expecting to show tooltip')\n }}\n onHideContent={(e) => {\n console.log('expecting to hide tooltip')\n }}\n >\n This link has a tooltip\n \n

\n {\n this.setState({ isShowingContent: event.target.checked })\n }}\n />\n \n )\n }\n }\n\n render()\n ```\n\n- ```js\n const Example = () => {\n const [isShowingContent, setIsShowingContent] = useState(false)\n\n return (\n <>\n

\n {\n console.log('expecting to show tooltip')\n }}\n onHideContent={(e) => {\n console.log('expecting to hide tooltip')\n }}\n >\n This link has a tooltip\n \n

\n {\n setIsShowingContent(event.target.checked)\n }}\n />\n \n )\n }\n\n render()\n ```\n\n### Custom elements as renderTrigger\n\nPopover and Tooltip attach mouse and focus event listeners to their render trigger components via props. These need to be propagated to the component for the listeners to work:\n\n- ```js\n class MyComponent extends React.Component {\n constructor(props) {\n super(props)\n this.ref = React.createRef()\n }\n render() {\n // Spread the props to the underlying DOM element\n return (\n
\n My custom component\n
\n )\n }\n }\n ;\n \n \n ```\n\n- ```js\n const MyComponent = forwardRef((props, ref) => {\n return (\n
\n My custom component\n
\n )\n })\n\n ;\n \n \n ```\n\n### Guidelines\n\n```js\n---\ntype: embed\n---\n\n
\n Use on icons with no labels\n Use on condensed dates\n Use on table content if items are getting truncated\n Use to provide more specific data (ie. user hovers over a chart element, Tooltip shows precise info)\n Try to stay within 50 characters\n
\n
\n Repeat the exact information contained on the triggering element\n Contain links or focusable items\n Use icons inside Tooltips\n Use in place of a Popover or Menu\n
\n\n```\n","displayName":"Tooltip","methods":[],"props":{"elementRef":{"type":{"name":"func"},"required":false,"description":"provides a reference to the underlying html root element","tsType":{"name":"signature","type":"function","raw":"(element: Element | null) => void","signature":{"arguments":[{"type":{"name":"union","raw":"Element | null","elements":[{"name":"Element"},{"name":"null"}]},"name":"element"}],"return":{"name":"void"}}}},"children":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"A ReactNode or a function that returns a ReactNode with the following params:\n\n@param {Boolean} focused - Is the Tooltip trigger focused?\n@param {Function} getTriggerProps - Props to be spread onto the trigger element","tsType":{"name":"union","raw":"React.ReactNode | TooltipRenderChildren","elements":[{"name":"ReactReactNode","raw":"React.ReactNode"},{"name":"signature","type":"function","raw":"(\n args: TooltipRenderChildrenArgs\n) => React.ReactNode","signature":{"arguments":[{"type":{"name":"signature","type":"object","raw":"{\n focused: boolean\n getTriggerProps: >(\n props: TriggerProps\n ) => { 'aria-describedby': string } & TriggerProps\n}","signature":{"properties":[{"key":"focused","value":{"name":"boolean","required":true}},{"key":"getTriggerProps","value":{"name":"signature","type":"function","raw":">(\n props: TriggerProps\n) => { 'aria-describedby': string } & TriggerProps","signature":{"arguments":[{"type":{"name":"TriggerProps"},"name":"props"}],"return":{"name":"intersection","raw":"{ 'aria-describedby': string } & TriggerProps","elements":[{"name":"signature","type":"object","raw":"{ 'aria-describedby': string }","signature":{"properties":[{"key":"aria-describedby","value":{"name":"string","required":true}}]}},{"name":"TriggerProps"}]}},"required":true}}]}},"name":"args"}],"return":{"name":"ReactReactNode","raw":"React.ReactNode"}}}]}},"renderTip":{"type":{"name":"union","value":[{"name":"node"},{"name":"func"}]},"required":true,"description":"The content to render in the tooltip","tsType":{"name":"union","raw":"| keyof ReactHTML\n| keyof ReactSVG\n| ClassType, ClassicComponentClass

>\n| ComponentClass\n| ReactNode\n| ((data: P) => ReactNode | Element)\n| (() => ReactNode | Element)\n| Element","elements":[{"name":"ReactHTML"},{"name":"ReactSVG"},{"name":"ClassType","elements":[{"name":"P"},{"name":"ClassicComponent","elements":[{"name":"P"},{"name":"ComponentState"}],"raw":"ClassicComponent"},{"name":"ClassicComponentClass","elements":[{"name":"P"}],"raw":"ClassicComponentClass

"}],"raw":"ClassType, ClassicComponentClass

>"},{"name":"ComponentClass"},{"name":"ReactNode"},{"name":"unknown"},{"name":"unknown"},{"name":"Element"}]}},"isShowingContent":{"type":{"name":"bool"},"required":false,"description":"Whether or not the tooltip content is shown, when controlled","tsType":{"name":"boolean"}},"defaultIsShowingContent":{"type":{"name":"bool"},"required":false,"description":"Whether or not to show the content by default, when uncontrolled","tsType":{"name":"boolean"},"defaultValue":{"value":"false","computed":false}},"as":{"type":{"name":"elementType"},"required":false,"description":"the element type to render as (assumes a single child if 'as' is undefined)","tsType":{"name":"union","raw":"keyof JSX.IntrinsicElements | ComponentType

","elements":[{"name":"JSX.IntrinsicElements"},{"name":"ComponentType","elements":[{"name":"P"}],"raw":"ComponentType

"}]}},"on":{"type":{"name":"union","value":[{"name":"enum","value":[{"value":"'click'","computed":false},{"value":"'hover'","computed":false},{"value":"'focus'","computed":false}]},{"name":"arrayOf","value":{"name":"enum","value":[{"value":"'click'","computed":false},{"value":"'hover'","computed":false},{"value":"'focus'","computed":false}]}}]},"required":false,"description":"The action that causes the Content to display (`click`, `hover`, `focus`)","tsType":{"name":"union","raw":"('click' | 'hover' | 'focus') | ('click' | 'hover' | 'focus')[]","elements":[{"name":"unknown"},{"name":"Array","elements":[{"name":"unknown"}],"raw":"('click' | 'hover' | 'focus')[]"}]}},"color":{"type":{"name":"enum","value":[{"value":"'primary'","computed":false},{"value":"'primary-inverse'","computed":false}]},"required":false,"description":"The color of the tooltip content","tsType":{"name":"union","raw":"'primary' | 'primary-inverse'","elements":[{"name":"literal","value":"'primary'"},{"name":"literal","value":"'primary-inverse'"}]},"defaultValue":{"value":"'primary'","computed":false}},"placement":{"type":{"name":"custom","raw":"PositionPropTypes.placement"},"required":false,"description":"Specifies where the Tooltip will be placed in relation to the target element.\nEx. placement=\"bottom\" will render the Tooltip below the triggering element\n(Note: if there is not room, it will position opposite. Ex. \"top\" will\nautomatically switch to \"bottom\")","tsType":{"name":"PlacementPropValues"},"defaultValue":{"value":"'top'","computed":false}},"mountNode":{"type":{"name":"custom","raw":"PositionPropTypes.mountNode"},"required":false,"description":"An element or a function returning an element to use as the mount node\nfor the `` (defaults to `document.body`)","tsType":{"name":"PositionMountNode"}},"constrain":{"type":{"name":"custom","raw":"PositionPropTypes.constrain"},"required":false,"description":"The parent in which to constrain the tooltip.\nOne of: 'window', 'scroll-parent', 'parent', 'none', an element,\nor a function returning an element","tsType":{"name":"PositionConstraint"},"defaultValue":{"value":"'window'","computed":false}},"offsetX":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"The horizontal offset for the positioned content","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]},"defaultValue":{"value":"0","computed":false}},"offsetY":{"type":{"name":"union","value":[{"name":"string"},{"name":"number"}]},"required":false,"description":"The vertical offset for the positioned content","tsType":{"name":"union","raw":"string | number","elements":[{"name":"string"},{"name":"number"}]},"defaultValue":{"value":"0","computed":false}},"positionTarget":{"type":{"name":"union","value":[{"name":"element"},{"name":"func"}]},"required":false,"description":"Target element for positioning the Tooltip (if it differs from children/trigger)","tsType":{"name":"PositionMountNode"}},"onShowContent":{"type":{"name":"func"},"required":false,"description":"Callback fired when content is shown. When controlled, this callback is\nfired when the tooltip expects to be shown","tsType":{"name":"signature","type":"function","raw":"(event: React.UIEvent | React.FocusEvent) => void","signature":{"arguments":[{"type":{"name":"union","raw":"React.UIEvent | React.FocusEvent","elements":[{"name":"ReactUIEvent","raw":"React.UIEvent"},{"name":"ReactFocusEvent","raw":"React.FocusEvent"}]},"name":"event"}],"return":{"name":"void"}}}},"onHideContent":{"type":{"name":"func"},"required":false,"description":"Callback fired when content is hidden. When controlled, this callback is\nfired when the tooltip expects to be hidden","tsType":{"name":"signature","type":"function","raw":"(\n event: React.UIEvent | React.FocusEvent,\n args: { documentClick: boolean }\n) => void","signature":{"arguments":[{"type":{"name":"union","raw":"React.UIEvent | React.FocusEvent","elements":[{"name":"ReactUIEvent","raw":"React.UIEvent"},{"name":"ReactFocusEvent","raw":"React.FocusEvent"}]},"name":"event"},{"type":{"name":"signature","type":"object","raw":"{ documentClick: boolean }","signature":{"properties":[{"key":"documentClick","value":{"name":"boolean","required":true}}]}},"name":"args"}],"return":{"name":"void"}}}},"dir":{"required":false,"tsType":{"name":"union","raw":"'ltr' | 'rtl'","elements":[{"name":"literal","value":"'ltr'"},{"name":"literal","value":"'rtl'"}]},"description":""}},"category":"components","relativePath":"packages/ui-tooltip/src/Tooltip/index.tsx","extension":".tsx","srcPath":"packages/ui-tooltip/src/Tooltip/index.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-tooltip/src/Tooltip/index.tsx","packageName":"@instructure/ui-tooltip","requirePath":"@instructure/ui-tooltip/lib/Tooltip/index","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-tooltip/src/Tooltip/index.tsx').default","esPath":"@instructure/ui-tooltip/es/Tooltip/index","themePath":"packages/ui-tooltip/src/Tooltip/theme.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-tooltip/src/Tooltip/theme.ts","id":"Tooltip","title":"Tooltip"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/TopNavBarContext.json b/pr-preview/pr-1690/docs/TopNavBarContext.json index f21f55dd85..7badbe7876 100644 --- a/pr-preview/pr-1690/docs/TopNavBarContext.json +++ b/pr-preview/pr-1690/docs/TopNavBarContext.json @@ -1 +1 @@ -{"comment":"/**\n---\nprivate: true\n---\n@module TopNavBarContext\n**/","meta":{"filename":"ryrwut6i6zdzhaz0riu7b.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":"gjck549dxzn8u4lfg6wga6.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-1690/docs/addElementQueryMatchListener.json b/pr-preview/pr-1690/docs/addElementQueryMatchListener.json index a4b21d4c6f..23428e02c1 100644 --- a/pr-preview/pr-1690/docs/addElementQueryMatchListener.json +++ b/pr-preview/pr-1690/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":"9j9xnc26d7fvoc6lvbbgk.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":"kho74f3h7nvc0e4cvey2h.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-1690/docs/addEventListener.json b/pr-preview/pr-1690/docs/addEventListener.json index 6961df5426..b4406123db 100644 --- a/pr-preview/pr-1690/docs/addEventListener.json +++ b/pr-preview/pr-1690/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":"w7y3dnlnp6frhd2p1z044f.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":"5ozajxylc7ud4hjllrrw9q.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-1690/docs/addMediaQueryMatchListener.json b/pr-preview/pr-1690/docs/addMediaQueryMatchListener.json index 7f85a9a271..e490f0181d 100644 --- a/pr-preview/pr-1690/docs/addMediaQueryMatchListener.json +++ b/pr-preview/pr-1690/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":"swqek15sn5fmyoiw8qtik.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":"cn3f8qxu4u902gsie7fwz6w.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-1690/docs/addPositionChangeListener.json b/pr-preview/pr-1690/docs/addPositionChangeListener.json index e002226302..1fa3ed10f2 100644 --- a/pr-preview/pr-1690/docs/addPositionChangeListener.json +++ b/pr-preview/pr-1690/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":"8bpsrgr1w2heu1430f5ran.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":"8bpsrgr1w2heu1430f5ran","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:8bpsrgr1w2heu1430f5ran","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":"g6ij7hzlyg9nlqlam76etm.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":"g6ij7hzlyg9nlqlam76etm","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:g6ij7hzlyg9nlqlam76etm","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-1690/docs/alpha.json b/pr-preview/pr-1690/docs/alpha.json index 85afec6448..da95919aff 100644 --- a/pr-preview/pr-1690/docs/alpha.json +++ b/pr-preview/pr-1690/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":"yei6l7wza20vi22ndmz88.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":"ffqy0xlta8p4b90ytukl37.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-1690/docs/calculateElementPosition.json b/pr-preview/pr-1690/docs/calculateElementPosition.json index d31765a0a8..db0cc89060 100644 --- a/pr-preview/pr-1690/docs/calculateElementPosition.json +++ b/pr-preview/pr-1690/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":"j64x0g0jd8ftzev5jbltg.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":"j64x0g0jd8ftzev5jbltg","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:j64x0g0jd8ftzev5jbltg","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":"ws44pg60gi63bjjkw0zd5.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":"ws44pg60gi63bjjkw0zd5","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:ws44pg60gi63bjjkw0zd5","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-1690/docs/callRenderProp.json b/pr-preview/pr-1690/docs/callRenderProp.json index 4b6fda2f26..097eebf04a 100644 --- a/pr-preview/pr-1690/docs/callRenderProp.json +++ b/pr-preview/pr-1690/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":"2bnpndfipcz1m46qw8podj.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":"hz5ckf67t2leq2134qqi78.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-1690/docs/camelize.json b/pr-preview/pr-1690/docs/camelize.json index 3ae9aab371..a79e79b152 100644 --- a/pr-preview/pr-1690/docs/camelize.json +++ b/pr-preview/pr-1690/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":"o6xx3mi7t3rqkce4eauk9.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":"o4ad5j1rvisp36qde9nt98.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-1690/docs/canUseDOM.json b/pr-preview/pr-1690/docs/canUseDOM.json index 5c85480db1..71d4dbe6bc 100644 --- a/pr-preview/pr-1690/docs/canUseDOM.json +++ b/pr-preview/pr-1690/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":"lj6nva3ul6gn1vr8j8ec7.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"lj6nva3ul6gn1vr8j8ec7","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:lj6nva3ul6gn1vr8j8ec7","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":"njgr1ymv847wzvx5f6j38.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nPerforms simple test to determine if DOM can be accessed","kind":"module","name":"njgr1ymv847wzvx5f6j38","returns":[{"type":{"names":["boolean"]},"description":"whether the dom can be used"}],"longname":"module:njgr1ymv847wzvx5f6j38","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-1690/docs/capitalizeFirstLetter.json b/pr-preview/pr-1690/docs/capitalizeFirstLetter.json index 5d0ec1553f..f29a151239 100644 --- a/pr-preview/pr-1690/docs/capitalizeFirstLetter.json +++ b/pr-preview/pr-1690/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":"sexqzfn1urplla0or1bxo.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":"ggsxsx5c7gr3tvsx4m55bu.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-1690/docs/childrenOrValue.json b/pr-preview/pr-1690/docs/childrenOrValue.json index 8e15a9dbb0..a9e73e01c5 100644 --- a/pr-preview/pr-1690/docs/childrenOrValue.json +++ b/pr-preview/pr-1690/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":"mtvr9olenyenl4pa3hzsyd.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":"yaepny3axgqiv9bxizb8rp.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-1690/docs/cloneArray.json b/pr-preview/pr-1690/docs/cloneArray.json index 23d5537d7a..301951ea3b 100644 --- a/pr-preview/pr-1690/docs/cloneArray.json +++ b/pr-preview/pr-1690/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":"223460nzcdlfdu5yf7av1k.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":"tgf3e77p1g857666hnjdni.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-1690/docs/contains.json b/pr-preview/pr-1690/docs/contains.json index 6023724fe3..83a8e5bafb 100644 --- a/pr-preview/pr-1690/docs/contains.json +++ b/pr-preview/pr-1690/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":"dkcdjd32se7l7fhmmg4brn.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":"1ay7hcnz4i7mn6xuc4nsr.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-1690/docs/containsActiveElement.json b/pr-preview/pr-1690/docs/containsActiveElement.json index 943fc136a5..cae1701782 100644 --- a/pr-preview/pr-1690/docs/containsActiveElement.json +++ b/pr-preview/pr-1690/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":"q78679isvec3gh4e1opqxr.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":"z3xs75hozmmm6sul1zs05g.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-1690/docs/contrast.json b/pr-preview/pr-1690/docs/contrast.json index ce446bea80..07b7f83211 100644 --- a/pr-preview/pr-1690/docs/contrast.json +++ b/pr-preview/pr-1690/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":"bkc1lgfkm169vty1hv3fd.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":"1ys5ia8mi5qyramm7hpb9.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-1690/docs/controllable.json b/pr-preview/pr-1690/docs/controllable.json index 70a41627b7..ef8691a782 100644 --- a/pr-preview/pr-1690/docs/controllable.json +++ b/pr-preview/pr-1690/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":"xo0m815qxnwlyxk97x4bh.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":"fabjn0dbtuq0henmkvnt4ht.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-1690/docs/conversions.json b/pr-preview/pr-1690/docs/conversions.json index 7823ff4ed9..f6d292b5cb 100644 --- a/pr-preview/pr-1690/docs/conversions.json +++ b/pr-preview/pr-1690/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":"vmi9wupx5orv3ykkht4f.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":"y0ypknfjjahcrg49cnefhf.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-1690/docs/createChainedFunction.json b/pr-preview/pr-1690/docs/createChainedFunction.json index 9ad14724a1..41f1fa3196 100644 --- a/pr-preview/pr-1690/docs/createChainedFunction.json +++ b/pr-preview/pr-1690/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":"vh547e1ilbzh0c61sd8am.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":"wn8hykudeppxa7czt0h3a.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-1690/docs/cursor.json b/pr-preview/pr-1690/docs/cursor.json index 0872ec51b6..ef2fa520fd 100644 --- a/pr-preview/pr-1690/docs/cursor.json +++ b/pr-preview/pr-1690/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":"zggb0o7fasbyutedvqcq6.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":"m3q94o9yhm9xgt0l7zj5pk.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-1690/docs/darken.json b/pr-preview/pr-1690/docs/darken.json index f95e7ec71c..493b676fb2 100644 --- a/pr-preview/pr-1690/docs/darken.json +++ b/pr-preview/pr-1690/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":"si2wkl6qwj7440f6h6icj.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":"rbn13h3z3qidfom6420c2b.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-1690/docs/debounce.json b/pr-preview/pr-1690/docs/debounce.json index 0b24530e32..b7f1ad900d 100644 --- a/pr-preview/pr-1690/docs/debounce.json +++ b/pr-preview/pr-1690/docs/debounce.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\n * since the last time the debounced function was invoked. The debounced function comes with a cancel\n * method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\n * to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\n * The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\n * debounced function return the result of the last func invocation.\n *\n * [lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\n * doesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\n * so this is forked from the lodash source.\n *\n * Note: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\n * on unmounted components.\n * @module debounce\n *\n * @param {Function} func The function to debounce.\n * @param {number} [wait=0] The number of milliseconds to delay.\n * @param {Object} [options={}] The options object.\n * @param {boolean} [options.leading=false]\n * Specify invoking on the leading edge of the timeout.\n * @param {number} [options.maxWait]\n * The maximum time `func` is allowed to be delayed before it's invoked.\n * @param {boolean} [options.trailing=true]\n * Specify invoking on the trailing edge of the timeout.\n * @returns {Function} Returns the new debounced function.\n */","meta":{"filename":"mo52if7g1a825c9w6e9t6t.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\nsince the last time the debounced function was invoked. The debounced function comes with a cancel\nmethod to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\nto indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\nThe func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\ndebounced function return the result of the last func invocation.\n\n[lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\ndoesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\nso this is forked from the lodash source.\n\nNote: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\non unmounted components.","kind":"module","name":"debounce","params":[{"type":{"names":["function"]},"description":"The function to debounce.","name":"func"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay.","name":"wait"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":"{}","description":"The options object.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Specify invoking on the leading edge of the timeout.","name":"options.leading"},{"type":{"names":["number"]},"optional":true,"description":"The maximum time `func` is allowed to be delayed before it's invoked.","name":"options.maxWait"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Specify invoking on the trailing edge of the timeout.","name":"options.trailing"}],"returns":[{"type":{"names":["function"]},"description":"Returns the new debounced function."}],"longname":"module:debounce","undocumented":false,"category":"utilities","relativePath":"packages/debounce/src/debounce.ts","extension":".ts","srcPath":"packages/debounce/src/debounce.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","packageName":"@instructure/debounce","requirePath":"@instructure/debounce/lib/debounce","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/debounce/src/debounce.ts').default","esPath":"@instructure/debounce/es/debounce","themePath":"packages/debounce/src/debounce.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","id":"debounce","title":"debounce"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\n * since the last time the debounced function was invoked. The debounced function comes with a cancel\n * method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\n * to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\n * The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\n * debounced function return the result of the last func invocation.\n *\n * [lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\n * doesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\n * so this is forked from the lodash source.\n *\n * Note: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\n * on unmounted components.\n * @module debounce\n *\n * @param {Function} func The function to debounce.\n * @param {number} [wait=0] The number of milliseconds to delay.\n * @param {Object} [options={}] The options object.\n * @param {boolean} [options.leading=false]\n * Specify invoking on the leading edge of the timeout.\n * @param {number} [options.maxWait]\n * The maximum time `func` is allowed to be delayed before it's invoked.\n * @param {boolean} [options.trailing=true]\n * Specify invoking on the trailing edge of the timeout.\n * @returns {Function} Returns the new debounced function.\n */","meta":{"filename":"h3yjq58k5c8n12svuwmbl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Creates a debounced function that delays invoking func until after wait milliseconds have elapsed\nsince the last time the debounced function was invoked. The debounced function comes with a cancel\nmethod to cancel delayed func invocations and a flush method to immediately invoke them. Provide options\nto indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout.\nThe func is invoked with the last arguments provided to the debounced function. Subsequent calls to the\ndebounced function return the result of the last func invocation.\n\n[lodash.debounce](https://github.com/lodash/lodash/blob/master/debounce.js)\ndoesn't work well with [sinon fakeTimers](http://sinonjs.org/releases/v1.17.7/fake-timers/)\nso this is forked from the lodash source.\n\nNote: Modified from the original to check for cancelled boolean before invoking func to prevent React setState\non unmounted components.","kind":"module","name":"debounce","params":[{"type":{"names":["function"]},"description":"The function to debounce.","name":"func"},{"type":{"names":["number"]},"optional":true,"defaultvalue":0,"description":"The number of milliseconds to delay.","name":"wait"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":"{}","description":"The options object.","name":"options"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"Specify invoking on the leading edge of the timeout.","name":"options.leading"},{"type":{"names":["number"]},"optional":true,"description":"The maximum time `func` is allowed to be delayed before it's invoked.","name":"options.maxWait"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"Specify invoking on the trailing edge of the timeout.","name":"options.trailing"}],"returns":[{"type":{"names":["function"]},"description":"Returns the new debounced function."}],"longname":"module:debounce","undocumented":false,"category":"utilities","relativePath":"packages/debounce/src/debounce.ts","extension":".ts","srcPath":"packages/debounce/src/debounce.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","packageName":"@instructure/debounce","requirePath":"@instructure/debounce/lib/debounce","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/debounce/src/debounce.ts').default","esPath":"@instructure/debounce/es/debounce","themePath":"packages/debounce/src/debounce.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/debounce/src/debounce.ts","id":"debounce","title":"debounce"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/decorator.json b/pr-preview/pr-1690/docs/decorator.json index 3bd035422f..a8d1cfef59 100644 --- a/pr-preview/pr-1690/docs/decorator.json +++ b/pr-preview/pr-1690/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":"2zjjirwwcqip2w3hvk3zui.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":"8dr3ez98nbptta9ikf189.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-1690/docs/deepEqual.json b/pr-preview/pr-1690/docs/deepEqual.json index 3443af088f..c98f1b8ff5 100644 --- a/pr-preview/pr-1690/docs/deepEqual.json +++ b/pr-preview/pr-1690/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":"ocoks7h4n2scwauw2ye5xb.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":"lerc5vn4dtdhf5l5htrxb.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-1690/docs/deprecated.json b/pr-preview/pr-1690/docs/deprecated.json index 3fcfda224b..7385b367f4 100644 --- a/pr-preview/pr-1690/docs/deprecated.json +++ b/pr-preview/pr-1690/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":"viq9v36senmy19su27povt.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":"g6aqfuiec2sl9b25cnzrq.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-1690/docs/element.json b/pr-preview/pr-1690/docs/element.json index c7f435537b..3f57b006b3 100644 --- a/pr-preview/pr-1690/docs/element.json +++ b/pr-preview/pr-1690/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":"9ocw2eisdu68vg5988ekph.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":"z8cypf2my2ctyjohsjndw8.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-1690/docs/ensureSingleChild.json b/pr-preview/pr-1690/docs/ensureSingleChild.json index e92978dd5b..c0fd422528 100644 --- a/pr-preview/pr-1690/docs/ensureSingleChild.json +++ b/pr-preview/pr-1690/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":"otw2ybcsxngbmehlq1adbp.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":"4saws3xjemi7zzjx8rjnfl.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-1690/docs/experimental.json b/pr-preview/pr-1690/docs/experimental.json index 334769b70b..46fd2703d1 100644 --- a/pr-preview/pr-1690/docs/experimental.json +++ b/pr-preview/pr-1690/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":"kgrvgcrpz4sjdf3anmiglg.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":"d6m0epjpp2q0v7eahizm5y.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-1690/docs/findDOMNode.json b/pr-preview/pr-1690/docs/findDOMNode.json index 2cf95e9aa2..5ad342e803 100644 --- a/pr-preview/pr-1690/docs/findDOMNode.json +++ b/pr-preview/pr-1690/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":"c8py07q08rjoy3ft7u8m.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":"x8na2u6mu9ng4ai14mq6z5.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-1690/docs/findFocusable.json b/pr-preview/pr-1690/docs/findFocusable.json index 22424820fa..bd0c98e33d 100644 --- a/pr-preview/pr-1690/docs/findFocusable.json +++ b/pr-preview/pr-1690/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":"ohoufqxfhm7jaxj6gsczq.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":"1h3545b8a050nqjzts9z90o.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-1690/docs/findTabbable.json b/pr-preview/pr-1690/docs/findTabbable.json index 5880d31979..cccbbcbc59 100644 --- a/pr-preview/pr-1690/docs/findTabbable.json +++ b/pr-preview/pr-1690/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":"vzd6jcwjou1nx0nqbevvm.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":"882eeron7t8mrukbjzfeg8.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-1690/docs/getActiveElement.json b/pr-preview/pr-1690/docs/getActiveElement.json index d5fb9ddf6e..39d692af1c 100644 --- a/pr-preview/pr-1690/docs/getActiveElement.json +++ b/pr-preview/pr-1690/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":"tos9iq4otifzr3ntnc4zoh.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":"13ne2ut0puf20r9vt0u4tv.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-1690/docs/getBoundingClientRect.json b/pr-preview/pr-1690/docs/getBoundingClientRect.json index afaed5b386..a2ed02514a 100644 --- a/pr-preview/pr-1690/docs/getBoundingClientRect.json +++ b/pr-preview/pr-1690/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":"mnlmp2mk1p9r5finueovlo.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":"bdtnpyigcllr6pebraonmn.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-1690/docs/getBrowser.json b/pr-preview/pr-1690/docs/getBrowser.json index e1e549efe6..710afe363f 100644 --- a/pr-preview/pr-1690/docs/getBrowser.json +++ b/pr-preview/pr-1690/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":"h7nnpdse8r7q466ka9qn7.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":"51nbygyndxwawn84zblouw.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-1690/docs/getClassList.json b/pr-preview/pr-1690/docs/getClassList.json index 76d8dd32fe..8f92643166 100644 --- a/pr-preview/pr-1690/docs/getClassList.json +++ b/pr-preview/pr-1690/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":"earwgrkswuofok5e3ouqgl.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":"2zfz5ns409jok0dh8zusuq.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-1690/docs/getComputedStyle.json b/pr-preview/pr-1690/docs/getComputedStyle.json index 27cf88d752..73d36dd024 100644 --- a/pr-preview/pr-1690/docs/getComputedStyle.json +++ b/pr-preview/pr-1690/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":"s3rfvrqd78q53us97dntdp.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":"ob9zu3xorqjelfqq4yiy19.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-1690/docs/getDisplayName.json b/pr-preview/pr-1690/docs/getDisplayName.json index 9e6b7877b7..ddb3f64606 100644 --- a/pr-preview/pr-1690/docs/getDisplayName.json +++ b/pr-preview/pr-1690/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":"9u8nocuv4z78g7n2a1nnx6.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":"slk9urruextepuzb4s7t.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-1690/docs/getElementType.json b/pr-preview/pr-1690/docs/getElementType.json index 28371c07da..57ae406e38 100644 --- a/pr-preview/pr-1690/docs/getElementType.json +++ b/pr-preview/pr-1690/docs/getElementType.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the React element type for a component.\n *\n * @module getElementType\n * @param {ComponentType} Component\n * @param {Object} props\n * @param {Function} getDefault an optional function that returns the default element type\n * @returns {String} the element type\n */","meta":{"filename":"p2msypekwtng6rg1dhfb4s.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"Get the React element type for a component.","kind":"module","name":"getElementType","params":[{"type":{"names":["ComponentType"]},"name":"Component"},{"type":{"names":["Object"]},"name":"props"},{"type":{"names":["function"]},"description":"an optional function that returns the default element type","name":"getDefault"}],"returns":[{"type":{"names":["String"]},"description":"the element type"}],"longname":"module:getElementType","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getElementType.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getElementType.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getElementType","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getElementType.ts').default","esPath":"@instructure/ui-react-utils/es/getElementType","themePath":"packages/ui-react-utils/src/getElementType.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","id":"getElementType","title":"getElementType"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Get the React element type for a component.\n *\n * @module getElementType\n * @param {ComponentType} Component\n * @param {Object} props\n * @param {Function} getDefault an optional function that returns the default element type\n * @returns {String} the element type\n */","meta":{"filename":"3sujmwutulrqdttohd8s0p.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"Get the React element type for a component.","kind":"module","name":"getElementType","params":[{"type":{"names":["ComponentType"]},"name":"Component"},{"type":{"names":["Object"]},"name":"props"},{"type":{"names":["function"]},"description":"an optional function that returns the default element type","name":"getDefault"}],"returns":[{"type":{"names":["String"]},"description":"the element type"}],"longname":"module:getElementType","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getElementType.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getElementType.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getElementType","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getElementType.ts').default","esPath":"@instructure/ui-react-utils/es/getElementType","themePath":"packages/ui-react-utils/src/getElementType.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getElementType.ts","id":"getElementType","title":"getElementType"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/getFontSize.json b/pr-preview/pr-1690/docs/getFontSize.json index 384e9a7a1d..f4a861f943 100644 --- a/pr-preview/pr-1690/docs/getFontSize.json +++ b/pr-preview/pr-1690/docs/getFontSize.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Gets font size in px\n *\n * @module getFontSize\n * @param { Node | Window | React.ReactElement | React.Component | function | undefined | null } el - component or DOM node\n * @param { boolean } ignoreCache\n * @returns { number } font size in px\n */","meta":{"filename":"3dgebqewshow0exh9wtq6e.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGets font size in px","kind":"module","name":"getFontSize","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","undefined","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"name":"ignoreCache"}],"returns":[{"type":{"names":["number"]},"description":"font size in px"}],"longname":"module:getFontSize","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getFontSize.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getFontSize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getFontSize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getFontSize.ts').default","esPath":"@instructure/ui-dom-utils/es/getFontSize","themePath":"packages/ui-dom-utils/src/getFontSize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","id":"getFontSize","title":"getFontSize"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Gets font size in px\n *\n * @module getFontSize\n * @param { Node | Window | React.ReactElement | React.Component | function | undefined | null } el - component or DOM node\n * @param { boolean } ignoreCache\n * @returns { number } font size in px\n */","meta":{"filename":"o4er96ev0jj3bzp60gap42.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGets font size in px","kind":"module","name":"getFontSize","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","undefined","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"name":"ignoreCache"}],"returns":[{"type":{"names":["number"]},"description":"font size in px"}],"longname":"module:getFontSize","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getFontSize.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getFontSize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getFontSize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getFontSize.ts').default","esPath":"@instructure/ui-dom-utils/es/getFontSize","themePath":"packages/ui-dom-utils/src/getFontSize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getFontSize.ts","id":"getFontSize","title":"getFontSize"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/getInteraction.json b/pr-preview/pr-1690/docs/getInteraction.json index 5d0f46c97c..bae63f5d9b 100644 --- a/pr-preview/pr-1690/docs/getInteraction.json +++ b/pr-preview/pr-1690/docs/getInteraction.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\n * This is useful for form elements where consumers are able to either use the interaction prop as specified or the\n * native html disabled or readonly attributes\n * @module getInteraction\n * @param {Object} args\n * @param {Object} args.props - the component props\n * @param {string} args.props.interaction - specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'\n * @param {boolean} args.props.disabled - specifies if the component is disabled. Will take precedence over readOnly\n * @param {boolean} args.props.readOnly - specifies if the component is readonly\n * @param {Array} args.interactionTypes - an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default\n * @returns {String} one of 'enabled', 'disabled', or 'readonly'\n */","meta":{"filename":"v24htg1t68w05sltez4t.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\nThis is useful for form elements where consumers are able to either use the interaction prop as specified or the\nnative html disabled or readonly attributes","kind":"module","name":"getInteraction","params":[{"type":{"names":["Object"]},"name":"args"},{"type":{"names":["Object"]},"description":"the component props","name":"args.props"},{"type":{"names":["string"]},"description":"specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'","name":"args.props.interaction"},{"type":{"names":["boolean"]},"description":"specifies if the component is disabled. Will take precedence over readOnly","name":"args.props.disabled"},{"type":{"names":["boolean"]},"description":"specifies if the component is readonly","name":"args.props.readOnly"},{"type":{"names":["Array"]},"description":"an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default","name":"args.interactionTypes"}],"returns":[{"type":{"names":["String"]},"description":"one of 'enabled', 'disabled', or 'readonly'"}],"longname":"module:getInteraction","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getInteraction.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getInteraction.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getInteraction","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getInteraction.ts').default","esPath":"@instructure/ui-react-utils/es/getInteraction","themePath":"packages/ui-react-utils/src/getInteraction.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","id":"getInteraction","title":"getInteraction"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\n * This is useful for form elements where consumers are able to either use the interaction prop as specified or the\n * native html disabled or readonly attributes\n * @module getInteraction\n * @param {Object} args\n * @param {Object} args.props - the component props\n * @param {string} args.props.interaction - specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'\n * @param {boolean} args.props.disabled - specifies if the component is disabled. Will take precedence over readOnly\n * @param {boolean} args.props.readOnly - specifies if the component is readonly\n * @param {Array} args.interactionTypes - an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default\n * @returns {String} one of 'enabled', 'disabled', or 'readonly'\n */","meta":{"filename":"s364c44jl5wtn3csrywqb.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Parse the component props for the interaction type. It will return one of 'enabled', 'disabled', or 'readonly'.\nThis is useful for form elements where consumers are able to either use the interaction prop as specified or the\nnative html disabled or readonly attributes","kind":"module","name":"getInteraction","params":[{"type":{"names":["Object"]},"name":"args"},{"type":{"names":["Object"]},"description":"the component props","name":"args.props"},{"type":{"names":["string"]},"description":"specifies the interaction mode, one of 'enabled', 'disabled', or 'readonly'","name":"args.props.interaction"},{"type":{"names":["boolean"]},"description":"specifies if the component is disabled. Will take precedence over readOnly","name":"args.props.disabled"},{"type":{"names":["boolean"]},"description":"specifies if the component is readonly","name":"args.props.readOnly"},{"type":{"names":["Array"]},"description":"an array specifying the interaction types available to the component, ['disabled', 'readonly'] by default","name":"args.interactionTypes"}],"returns":[{"type":{"names":["String"]},"description":"one of 'enabled', 'disabled', or 'readonly'"}],"longname":"module:getInteraction","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/getInteraction.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/getInteraction.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/getInteraction","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/getInteraction.ts').default","esPath":"@instructure/ui-react-utils/es/getInteraction","themePath":"packages/ui-react-utils/src/getInteraction.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/getInteraction.ts","id":"getInteraction","title":"getInteraction"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/getOffsetParents.json b/pr-preview/pr-1690/docs/getOffsetParents.json index 0428c4f0f7..56bf37ba1f 100644 --- a/pr-preview/pr-1690/docs/getOffsetParents.json +++ b/pr-preview/pr-1690/docs/getOffsetParents.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieves the offset parents of a specified element.\n * Includes parents of nodeType 1 (Element nodes such\n * as

or

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

or

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

or

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

or

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

or

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

or

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

or

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

or

) that have overflow css properties\nset to auto, scroll, or overlay","kind":"module","name":"getScrollParents","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Array"]},"description":"scroll parents"}],"longname":"module:getScrollParents","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/getScrollParents.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/getScrollParents.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getScrollParents.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/getScrollParents","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/getScrollParents.ts').default","esPath":"@instructure/ui-dom-utils/es/getScrollParents","themePath":"packages/ui-dom-utils/src/getScrollParents.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/getScrollParents.ts","id":"getScrollParents","title":"getScrollParents"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/getShorthandPropValue.json b/pr-preview/pr-1690/docs/getShorthandPropValue.json index 56bce73fd7..bc37f53902 100644 --- a/pr-preview/pr-1690/docs/getShorthandPropValue.json +++ b/pr-preview/pr-1690/docs/getShorthandPropValue.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a theme object, a string of space delimited prop values,\n * and a propName prefix, combines each prop value with the\n * propName prefix and replaces it with a corresponding value\n * from the theme object.\n * @module getShorthandPropValue\n *\n * @param {String} componentName - the name of the component (for error messages)\n * @param {Object} componentTheme - a theme object of keys and values\n * @param {String} propValue - a space delimited string of values\n * @param {String} propName - a prefix to combine with each propValue\n * @returns {String} a string with each value replaced with a value from the theme object\n */","meta":{"filename":"bgsnv9gppgkwbkietmie.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a theme object, a string of space delimited prop values,\nand a propName prefix, combines each prop value with the\npropName prefix and replaces it with a corresponding value\nfrom the theme object.","kind":"module","name":"getShorthandPropValue","params":[{"type":{"names":["String"]},"description":"the name of the component (for error messages)","name":"componentName"},{"type":{"names":["Object"]},"description":"a theme object of keys and values","name":"componentTheme"},{"type":{"names":["String"]},"description":"a space delimited string of values","name":"propValue"},{"type":{"names":["String"]},"description":"a prefix to combine with each propValue","name":"propName"}],"returns":[{"type":{"names":["String"]},"description":"a string with each value replaced with a value from the theme object"}],"longname":"module:getShorthandPropValue","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/getShorthandPropValue","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/getShorthandPropValue.ts').default","esPath":"@instructure/emotion/es/styleUtils/getShorthandPropValue","themePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","id":"getShorthandPropValue","title":"getShorthandPropValue"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a theme object, a string of space delimited prop values,\n * and a propName prefix, combines each prop value with the\n * propName prefix and replaces it with a corresponding value\n * from the theme object.\n * @module getShorthandPropValue\n *\n * @param {String} componentName - the name of the component (for error messages)\n * @param {Object} componentTheme - a theme object of keys and values\n * @param {String} propValue - a space delimited string of values\n * @param {String} propName - a prefix to combine with each propValue\n * @returns {String} a string with each value replaced with a value from the theme object\n */","meta":{"filename":"3hn1msq8vmr33pzxueil04.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a theme object, a string of space delimited prop values,\nand a propName prefix, combines each prop value with the\npropName prefix and replaces it with a corresponding value\nfrom the theme object.","kind":"module","name":"getShorthandPropValue","params":[{"type":{"names":["String"]},"description":"the name of the component (for error messages)","name":"componentName"},{"type":{"names":["Object"]},"description":"a theme object of keys and values","name":"componentTheme"},{"type":{"names":["String"]},"description":"a space delimited string of values","name":"propValue"},{"type":{"names":["String"]},"description":"a prefix to combine with each propValue","name":"propName"}],"returns":[{"type":{"names":["String"]},"description":"a string with each value replaced with a value from the theme object"}],"longname":"module:getShorthandPropValue","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/getShorthandPropValue","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/getShorthandPropValue.ts').default","esPath":"@instructure/emotion/es/styleUtils/getShorthandPropValue","themePath":"packages/emotion/src/styleUtils/getShorthandPropValue.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/getShorthandPropValue.ts","id":"getShorthandPropValue","title":"getShorthandPropValue"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/getTextDirection.json b/pr-preview/pr-1690/docs/getTextDirection.json index 4f71772327..cbf94d2cc1 100644 --- a/pr-preview/pr-1690/docs/getTextDirection.json +++ b/pr-preview/pr-1690/docs/getTextDirection.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\n * is given, it returns the document's 'dir' value.\n * @module getTextDirection\n * @param {Element} element will use the element by default\n * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)\n */","meta":{"filename":"4gxlrs4lk6ora0aw1i8ds7.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"\nReturn the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\nis given, it returns the document's 'dir' value.","kind":"module","name":"getTextDirection","params":[{"type":{"names":["Element"]},"description":"will use the element by default","name":"element"}],"returns":[{"type":{"names":["String"]},"description":"'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)"}],"longname":"module:getTextDirection","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/getTextDirection.ts","extension":".ts","srcPath":"packages/ui-i18n/src/getTextDirection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/getTextDirection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/getTextDirection.ts').default","esPath":"@instructure/ui-i18n/es/getTextDirection","themePath":"packages/ui-i18n/src/getTextDirection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","id":"getTextDirection","title":"getTextDirection"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\n * is given, it returns the document's 'dir' value.\n * @module getTextDirection\n * @param {Element} element will use the element by default\n * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)\n */","meta":{"filename":"vkskczsgvggiacvbj0m1e.js","lineno":6,"columnno":0,"path":"/tmp","code":{}},"description":"\nReturn the direction ('ltr' or 'rtl' or 'auto') of an element. If no element\nis given, it returns the document's 'dir' value.","kind":"module","name":"getTextDirection","params":[{"type":{"names":["Element"]},"description":"will use the element by default","name":"element"}],"returns":[{"type":{"names":["String"]},"description":"'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)"}],"longname":"module:getTextDirection","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/getTextDirection.ts","extension":".ts","srcPath":"packages/ui-i18n/src/getTextDirection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/getTextDirection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/getTextDirection.ts').default","esPath":"@instructure/ui-i18n/es/getTextDirection","themePath":"packages/ui-i18n/src/getTextDirection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/getTextDirection.ts","id":"getTextDirection","title":"getTextDirection"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/hack.json b/pr-preview/pr-1690/docs/hack.json index 6044ed09c1..ec73451442 100644 --- a/pr-preview/pr-1690/docs/hack.json +++ b/pr-preview/pr-1690/docs/hack.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Flag React component props as hack props.\n * Warnings will display in the console when hack props are used.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default hack(['hackProp'])(Example)\n * ```\n *\n * @module hack\n * @param {array} hackProps\n * @param {string} message\n * @return {function} React component flagged as having hack props\n */","meta":{"filename":"ibglp89v3um2ymm6727vg.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Flag React component props as hack props.\nWarnings will display in the console when hack props are used.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default hack(['hackProp'])(Example)\n```","kind":"module","name":"hack","params":[{"type":{"names":["array"]},"name":"hackProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component flagged as having hack props"}],"longname":"module:hack","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/hack.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/hack.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/hack","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/hack.ts').default","esPath":"@instructure/ui-react-utils/es/hack","themePath":"packages/ui-react-utils/src/hack.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","id":"hack","title":"hack"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Flag React component props as hack props.\n * Warnings will display in the console when hack props are used.\n *\n * ```js-code\n * class Example extends Component {\n * static propTypes = {\n * currentProp: PropTypes.func\n * }\n * }\n * export default hack(['hackProp'])(Example)\n * ```\n *\n * @module hack\n * @param {array} hackProps\n * @param {string} message\n * @return {function} React component flagged as having hack props\n */","meta":{"filename":"cu9n79sdehs9sggzo0gur9.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Flag React component props as hack props.\nWarnings will display in the console when hack props are used.\n\n```js-code\n class Example extends Component {\n static propTypes = {\n currentProp: PropTypes.func\n }\n }\n export default hack(['hackProp'])(Example)\n```","kind":"module","name":"hack","params":[{"type":{"names":["array"]},"name":"hackProps"},{"type":{"names":["string"]},"name":"message"}],"returns":[{"type":{"names":["function"]},"description":"React component flagged as having hack props"}],"longname":"module:hack","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/hack.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/hack.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/hack","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/hack.ts').default","esPath":"@instructure/ui-react-utils/es/hack","themePath":"packages/ui-react-utils/src/hack.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/hack.ts","id":"hack","title":"hack"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/handleMouseOverOut.json b/pr-preview/pr-1690/docs/handleMouseOverOut.json index 5ad6566bfe..f221c305df 100644 --- a/pr-preview/pr-1690/docs/handleMouseOverOut.json +++ b/pr-preview/pr-1690/docs/handleMouseOverOut.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Simple implementation of mouseEnter and mouseLeave.\n * React's built version is broken: https://github.com/facebook/react/issues/4251\n * for cases when the trigger is disabled and mouseOut/Over can cause flicker moving\n * from one child element to another.\n *\n * @module handleMouseOverOut\n * @param handler {function} Callback function for handling the event\n * @param event {Event} The DOM Event that was fired\n */","meta":{"filename":"g0iv6qe5ri7cj122suyvoa.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nSimple implementation of mouseEnter and mouseLeave.\nReact's built version is broken: https://github.com/facebook/react/issues/4251\nfor cases when the trigger is disabled and mouseOut/Over can cause flicker moving\nfrom one child element to another.","kind":"module","name":"handleMouseOverOut","params":[{"type":{"names":["function"]},"description":"Callback function for handling the event","name":"handler"},{"type":{"names":["Event"]},"description":"The DOM Event that was fired","name":"event"}],"longname":"module:handleMouseOverOut","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/handleMouseOverOut","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/handleMouseOverOut.ts').default","esPath":"@instructure/ui-dom-utils/es/handleMouseOverOut","themePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","id":"handleMouseOverOut","title":"handleMouseOverOut"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Simple implementation of mouseEnter and mouseLeave.\n * React's built version is broken: https://github.com/facebook/react/issues/4251\n * for cases when the trigger is disabled and mouseOut/Over can cause flicker moving\n * from one child element to another.\n *\n * @module handleMouseOverOut\n * @param handler {function} Callback function for handling the event\n * @param event {Event} The DOM Event that was fired\n */","meta":{"filename":"e2v0jrcbaf7equo7xl9qyd.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nSimple implementation of mouseEnter and mouseLeave.\nReact's built version is broken: https://github.com/facebook/react/issues/4251\nfor cases when the trigger is disabled and mouseOut/Over can cause flicker moving\nfrom one child element to another.","kind":"module","name":"handleMouseOverOut","params":[{"type":{"names":["function"]},"description":"Callback function for handling the event","name":"handler"},{"type":{"names":["Event"]},"description":"The DOM Event that was fired","name":"event"}],"longname":"module:handleMouseOverOut","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/handleMouseOverOut","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/handleMouseOverOut.ts').default","esPath":"@instructure/ui-dom-utils/es/handleMouseOverOut","themePath":"packages/ui-dom-utils/src/handleMouseOverOut.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/handleMouseOverOut.ts","id":"handleMouseOverOut","title":"handleMouseOverOut"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/hasVisibleChildren.json b/pr-preview/pr-1690/docs/hasVisibleChildren.json index da36f03b97..c1f65f9dd0 100644 --- a/pr-preview/pr-1690/docs/hasVisibleChildren.json +++ b/pr-preview/pr-1690/docs/hasVisibleChildren.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n * Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).\n * @module hasVisibleChildren\n * @param {ReactChildren} children - A react component's children prop\n * @return {boolean} whether any of the children are visible\n */","meta":{"filename":"6xrdellem1qmn4p1t9iaam.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).","kind":"module","name":"hasVisibleChildren","params":[{"type":{"names":["ReactChildren"]},"description":"A react component's children prop","name":"children"}],"returns":[{"type":{"names":["boolean"]},"description":"whether any of the children are visible"}],"longname":"module:hasVisibleChildren","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/hasVisibleChildren","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/hasVisibleChildren.ts').default","esPath":"@instructure/ui-a11y-utils/es/hasVisibleChildren","themePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","id":"hasVisibleChildren","title":"hasVisibleChildren"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n * Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).\n * @module hasVisibleChildren\n * @param {ReactChildren} children - A react component's children prop\n * @return {boolean} whether any of the children are visible\n */","meta":{"filename":"cpwwn2veqllnxgdo064dqh.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Returns `true` if any of the children are not wrapped with [ScreenReaderContent](#ScreenReaderContent).","kind":"module","name":"hasVisibleChildren","params":[{"type":{"names":["ReactChildren"]},"description":"A react component's children prop","name":"children"}],"returns":[{"type":{"names":["boolean"]},"description":"whether any of the children are visible"}],"longname":"module:hasVisibleChildren","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/hasVisibleChildren","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/hasVisibleChildren.ts').default","esPath":"@instructure/ui-a11y-utils/es/hasVisibleChildren","themePath":"packages/ui-a11y-utils/src/hasVisibleChildren.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/hasVisibleChildren.ts","id":"hasVisibleChildren","title":"hasVisibleChildren"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/isActiveElement.json b/pr-preview/pr-1690/docs/isActiveElement.json index 088700ff16..d0a47092c1 100644 --- a/pr-preview/pr-1690/docs/isActiveElement.json +++ b/pr-preview/pr-1690/docs/isActiveElement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is the active element\n * @module isActiveElement\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {boolean} if the element is the active element\n */","meta":{"filename":"ib9pludlbjjx81yjsus47a.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is the active element","kind":"module","name":"isActiveElement","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is the active element"}],"longname":"module:isActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isActiveElement","themePath":"packages/ui-dom-utils/src/isActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","id":"isActiveElement","title":"isActiveElement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is the active element\n * @module isActiveElement\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @returns {boolean} if the element is the active element\n */","meta":{"filename":"nq61hmul19mi6lxz1c9vb.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is the active element","kind":"module","name":"isActiveElement","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is the active element"}],"longname":"module:isActiveElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isActiveElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isActiveElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isActiveElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isActiveElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isActiveElement","themePath":"packages/ui-dom-utils/src/isActiveElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isActiveElement.ts","id":"isActiveElement","title":"isActiveElement"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/isDefinedCustomElement.json b/pr-preview/pr-1690/docs/isDefinedCustomElement.json index 8b94b14039..325715c6ba 100644 --- a/pr-preview/pr-1690/docs/isDefinedCustomElement.json +++ b/pr-preview/pr-1690/docs/isDefinedCustomElement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Check whether an element is a defined custom element. (if it was defined with `customElements.define`)\n * @module isDefinedCustomElement\n * @param { Element } el - the element to check\n * @return { Boolean } whether the element is a custom element or not\n */","meta":{"filename":"3a3jx82pyv4tvad7rzb9hq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nCheck whether an element is a defined custom element. (if it was defined with `customElements.define`)","kind":"module","name":"isDefinedCustomElement","params":[{"type":{"names":["Element"]},"description":"the element to check","name":"el"}],"returns":[{"type":{"names":["Boolean"]},"description":"whether the element is a custom element or not"}],"longname":"module:isDefinedCustomElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isDefinedCustomElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isDefinedCustomElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isDefinedCustomElement","themePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","id":"isDefinedCustomElement","title":"isDefinedCustomElement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Check whether an element is a defined custom element. (if it was defined with `customElements.define`)\n * @module isDefinedCustomElement\n * @param { Element } el - the element to check\n * @return { Boolean } whether the element is a custom element or not\n */","meta":{"filename":"eu3n6q5viqu878yyq6wrv8.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nCheck whether an element is a defined custom element. (if it was defined with `customElements.define`)","kind":"module","name":"isDefinedCustomElement","params":[{"type":{"names":["Element"]},"description":"the element to check","name":"el"}],"returns":[{"type":{"names":["Boolean"]},"description":"whether the element is a custom element or not"}],"longname":"module:isDefinedCustomElement","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isDefinedCustomElement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isDefinedCustomElement.ts').default","esPath":"@instructure/ui-dom-utils/es/isDefinedCustomElement","themePath":"packages/ui-dom-utils/src/isDefinedCustomElement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isDefinedCustomElement.ts","id":"isDefinedCustomElement","title":"isDefinedCustomElement"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/isValid.json b/pr-preview/pr-1690/docs/isValid.json index b107396a8b..6318ddc00b 100644 --- a/pr-preview/pr-1690/docs/isValid.json +++ b/pr-preview/pr-1690/docs/isValid.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * check if a string is a valid color\n * @module isValid\n * @param {String} color\n * @returns {Boolean} true if the string is a valid color\n */","meta":{"filename":"pf4h4fuw0obgguig14bfi.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"check if a string is a valid color","kind":"module","name":"isValid","params":[{"type":{"names":["String"]},"name":"color"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the string is a valid color"}],"longname":"module:isValid","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/isValid.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/isValid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/isValid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/isValid.ts').default","esPath":"@instructure/ui-color-utils/es/isValid","themePath":"packages/ui-color-utils/src/isValid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","id":"isValid","title":"isValid"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * check if a string is a valid color\n * @module isValid\n * @param {String} color\n * @returns {Boolean} true if the string is a valid color\n */","meta":{"filename":"igj8zr22ifo1nxs8s5anb6.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"check if a string is a valid color","kind":"module","name":"isValid","params":[{"type":{"names":["String"]},"name":"color"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the string is a valid color"}],"longname":"module:isValid","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/isValid.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/isValid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/isValid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/isValid.ts').default","esPath":"@instructure/ui-color-utils/es/isValid","themePath":"packages/ui-color-utils/src/isValid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/isValid.ts","id":"isValid","title":"isValid"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/isVisible.json b/pr-preview/pr-1690/docs/isVisible.json index a1f7a532c0..64e1a0b6a9 100644 --- a/pr-preview/pr-1690/docs/isVisible.json +++ b/pr-preview/pr-1690/docs/isVisible.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is visible.\n *\n * @module isVisible\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param {boolean} recursive - by default all parent elements are checked\n * recursively to accurately determine visibility. setting this to `false`\n * will determine visibility based only on the styles of the given node.\n * @returns {boolean} if the element is visible\n */","meta":{"filename":"e7bpy5urhxohsrmzo5ysyr.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is visible.","kind":"module","name":"isVisible","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"description":"by default all parent elements are checked\nrecursively to accurately determine visibility. setting this to `false`\nwill determine visibility based only on the styles of the given node.","name":"recursive"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is visible"}],"longname":"module:isVisible","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isVisible.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isVisible.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isVisible","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isVisible.ts').default","esPath":"@instructure/ui-dom-utils/es/isVisible","themePath":"packages/ui-dom-utils/src/isVisible.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","id":"isVisible","title":"isVisible"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Determine if an element is visible.\n *\n * @module isVisible\n * @param { Node | Window | React.ReactElement | React.Component | function | null } el - component or DOM node\n * @param {boolean} recursive - by default all parent elements are checked\n * recursively to accurately determine visibility. setting this to `false`\n * will determine visibility based only on the styles of the given node.\n * @returns {boolean} if the element is visible\n */","meta":{"filename":"duy8632p7rkbgrprj3t4pd.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nDetermine if an element is visible.","kind":"module","name":"isVisible","params":[{"type":{"names":["Node","Window","React.ReactElement","React.Component","function","null"]},"description":"component or DOM node","name":"el"},{"type":{"names":["boolean"]},"description":"by default all parent elements are checked\nrecursively to accurately determine visibility. setting this to `false`\nwill determine visibility based only on the styles of the given node.","name":"recursive"}],"returns":[{"type":{"names":["boolean"]},"description":"if the element is visible"}],"longname":"module:isVisible","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/isVisible.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/isVisible.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/isVisible","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/isVisible.ts').default","esPath":"@instructure/ui-dom-utils/es/isVisible","themePath":"packages/ui-dom-utils/src/isVisible.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/isVisible.ts","id":"isVisible","title":"isVisible"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/jsonToMediaQuery.json b/pr-preview/pr-1690/docs/jsonToMediaQuery.json index 1c08a33559..ab6e1f0659 100644 --- a/pr-preview/pr-1690/docs/jsonToMediaQuery.json +++ b/pr-preview/pr-1690/docs/jsonToMediaQuery.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a valid json query object, converts it to a standard media query\n * string. Valid queries should be an object consisting of condition:breakpoint\n * pairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\n * or `maxHeight` where breakpoint value is either a string or a number.\n *\n * Example input\n * ```js-code\n * { minWidth: 350, maxWidth: 600 }\n * ```\n * Example output\n * ```js-code\n * '(min-width: 350px) and (max-Width: 600px)'\n * ```\n * @module jsonToMediaQuery\n * @param {Object} query - an object consisting of the query type and value\n * @param {Document | Window | Node | React.ReactElement | React.Component} el - component or DOM node which will be passed to the pixel conversion if the unit type is `em`\n * @returns {string} media query string\n */","meta":{"filename":"a05bgydxw5rsosd0674n.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a valid json query object, converts it to a standard media query\nstring. Valid queries should be an object consisting of condition:breakpoint\npairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\nor `maxHeight` where breakpoint value is either a string or a number.\n\nExample input\n```js-code\n{ minWidth: 350, maxWidth: 600 }\n```\nExample output\n```js-code\n'(min-width: 350px) and (max-Width: 600px)'\n```","kind":"module","name":"jsonToMediaQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of the query type and value","name":"query"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component"]},"description":"component or DOM node which will be passed to the pixel conversion if the unit type is `em`","name":"el"}],"returns":[{"type":{"names":["string"]},"description":"media query string"}],"longname":"module:jsonToMediaQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/jsonToMediaQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/jsonToMediaQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/jsonToMediaQuery.ts').default","esPath":"@instructure/ui-responsive/es/jsonToMediaQuery","themePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","id":"jsonToMediaQuery","title":"jsonToMediaQuery"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a valid json query object, converts it to a standard media query\n * string. Valid queries should be an object consisting of condition:breakpoint\n * pairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\n * or `maxHeight` where breakpoint value is either a string or a number.\n *\n * Example input\n * ```js-code\n * { minWidth: 350, maxWidth: 600 }\n * ```\n * Example output\n * ```js-code\n * '(min-width: 350px) and (max-Width: 600px)'\n * ```\n * @module jsonToMediaQuery\n * @param {Object} query - an object consisting of the query type and value\n * @param {Document | Window | Node | React.ReactElement | React.Component} el - component or DOM node which will be passed to the pixel conversion if the unit type is `em`\n * @returns {string} media query string\n */","meta":{"filename":"feexn7fzm3tl9q39zn80e.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a valid json query object, converts it to a standard media query\nstring. Valid queries should be an object consisting of condition:breakpoint\npairs with the following condition types `minWidth`, `maxWidth`, `minHeight`,\nor `maxHeight` where breakpoint value is either a string or a number.\n\nExample input\n```js-code\n{ minWidth: 350, maxWidth: 600 }\n```\nExample output\n```js-code\n'(min-width: 350px) and (max-Width: 600px)'\n```","kind":"module","name":"jsonToMediaQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of the query type and value","name":"query"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component"]},"description":"component or DOM node which will be passed to the pixel conversion if the unit type is `em`","name":"el"}],"returns":[{"type":{"names":["string"]},"description":"media query string"}],"longname":"module:jsonToMediaQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/jsonToMediaQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/jsonToMediaQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/jsonToMediaQuery.ts').default","esPath":"@instructure/ui-responsive/es/jsonToMediaQuery","themePath":"packages/ui-responsive/src/jsonToMediaQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/jsonToMediaQuery.ts","id":"jsonToMediaQuery","title":"jsonToMediaQuery"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/lighten.json b/pr-preview/pr-1690/docs/lighten.json index 12c1deedce..c2f7933e6e 100644 --- a/pr-preview/pr-1690/docs/lighten.json +++ b/pr-preview/pr-1690/docs/lighten.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * lighten a color\n * @module lighten\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"qndqur0cjj7h4xrx78eer.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"lighten a color","kind":"module","name":"lighten","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:lighten","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/lighten.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/lighten.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/lighten","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/lighten.ts').default","esPath":"@instructure/ui-color-utils/es/lighten","themePath":"packages/ui-color-utils/src/lighten.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","id":"lighten","title":"lighten"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * lighten a color\n * @module lighten\n * @param {String} color\n * @param {Number} percent\n * @returns {String} color as rgb string\n */","meta":{"filename":"qyss0e68b2s5w601xdiqc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"lighten a color","kind":"module","name":"lighten","params":[{"type":{"names":["String"]},"name":"color"},{"type":{"names":["Number"]},"name":"percent"}],"returns":[{"type":{"names":["String"]},"description":"color as rgb string"}],"longname":"module:lighten","undocumented":false,"category":"utilities","relativePath":"packages/ui-color-utils/src/lighten.ts","extension":".ts","srcPath":"packages/ui-color-utils/src/lighten.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","packageName":"@instructure/ui-color-utils","requirePath":"@instructure/ui-color-utils/lib/lighten","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-color-utils/src/lighten.ts').default","esPath":"@instructure/ui-color-utils/es/lighten","themePath":"packages/ui-color-utils/src/lighten.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-color-utils/src/lighten.ts","id":"lighten","title":"lighten"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/makeRequirable.json b/pr-preview/pr-1690/docs/makeRequirable.json index af11aadd0e..0cf0c4fb94 100644 --- a/pr-preview/pr-1690/docs/makeRequirable.json +++ b/pr-preview/pr-1690/docs/makeRequirable.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Given a validator function, extends the validator functionality to also\n * ensure that the prop has been provided if `.isRequired` is specified.\n *\n * ```js-code\n * function validator (props, propName, componentName) {\n * const propValue = props[propName]\n * if (propValue === 'purple') {\n * return new Error(`Purple is not accepted in ${componentName}!`)\n * }\n * }\n *\n * validator.isRequired = makeRequirable(validator)\n * ```\n * @module makeRequirable\n * @param {function} validator - a validator function\n * @returns {function} A function that returns Error if designated prop is not provided\n */","meta":{"filename":"8pjpz5ozdagnkzrxdxqs3n.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a validator function, extends the validator functionality to also\nensure that the prop has been provided if `.isRequired` is specified.\n\n```js-code\nfunction validator (props, propName, componentName) {\n const propValue = props[propName]\n if (propValue === 'purple') {\n return new Error(`Purple is not accepted in ${componentName}!`)\n }\n}\n\nvalidator.isRequired = makeRequirable(validator)\n```","kind":"module","name":"makeRequirable","params":[{"type":{"names":["function"]},"description":"a validator function","name":"validator"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if designated prop is not provided"}],"longname":"module:makeRequirable","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/makeRequirable.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/makeRequirable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/makeRequirable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/makeRequirable.ts').default","esPath":"@instructure/ui-prop-types/es/makeRequirable","themePath":"packages/ui-prop-types/src/makeRequirable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","id":"makeRequirable","title":"makeRequirable"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Given a validator function, extends the validator functionality to also\n * ensure that the prop has been provided if `.isRequired` is specified.\n *\n * ```js-code\n * function validator (props, propName, componentName) {\n * const propValue = props[propName]\n * if (propValue === 'purple') {\n * return new Error(`Purple is not accepted in ${componentName}!`)\n * }\n * }\n *\n * validator.isRequired = makeRequirable(validator)\n * ```\n * @module makeRequirable\n * @param {function} validator - a validator function\n * @returns {function} A function that returns Error if designated prop is not provided\n */","meta":{"filename":"j2ktit0srnodz9kfqfq6.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a validator function, extends the validator functionality to also\nensure that the prop has been provided if `.isRequired` is specified.\n\n```js-code\nfunction validator (props, propName, componentName) {\n const propValue = props[propName]\n if (propValue === 'purple') {\n return new Error(`Purple is not accepted in ${componentName}!`)\n }\n}\n\nvalidator.isRequired = makeRequirable(validator)\n```","kind":"module","name":"makeRequirable","params":[{"type":{"names":["function"]},"description":"a validator function","name":"validator"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if designated prop is not provided"}],"longname":"module:makeRequirable","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/makeRequirable.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/makeRequirable.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/makeRequirable","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/makeRequirable.ts').default","esPath":"@instructure/ui-prop-types/es/makeRequirable","themePath":"packages/ui-prop-types/src/makeRequirable.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/makeRequirable.ts","id":"makeRequirable","title":"makeRequirable"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/makeThemeVars.json b/pr-preview/pr-1690/docs/makeThemeVars.json index c6ea73c70e..45dcb7ddb2 100644 --- a/pr-preview/pr-1690/docs/makeThemeVars.json +++ b/pr-preview/pr-1690/docs/makeThemeVars.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a prefix and a theme object, prepends the object keys with\n * the designated prefix and camel cases the concatenation.\n * @module makeThemeVars\n * @param {String} prefix - a string to prepend to object keys\n * @param {Object} vars - an object\n * @returns {Object} a modified object with prefixed keys\n */","meta":{"filename":"c25or1ah3sz1mszoey54s.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a prefix and a theme object, prepends the object keys with\nthe designated prefix and camel cases the concatenation.","kind":"module","name":"makeThemeVars","params":[{"type":{"names":["String"]},"description":"a string to prepend to object keys","name":"prefix"},{"type":{"names":["Object"]},"description":"an object","name":"vars"}],"returns":[{"type":{"names":["Object"]},"description":"a modified object with prefixed keys"}],"longname":"module:makeThemeVars","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/makeThemeVars.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/makeThemeVars","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/makeThemeVars.ts').default","esPath":"@instructure/emotion/es/styleUtils/makeThemeVars","themePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","id":"makeThemeVars","title":"makeThemeVars"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * Given a prefix and a theme object, prepends the object keys with\n * the designated prefix and camel cases the concatenation.\n * @module makeThemeVars\n * @param {String} prefix - a string to prepend to object keys\n * @param {Object} vars - an object\n * @returns {Object} a modified object with prefixed keys\n */","meta":{"filename":"beoev15n8c84563sfc200t.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a prefix and a theme object, prepends the object keys with\nthe designated prefix and camel cases the concatenation.","kind":"module","name":"makeThemeVars","params":[{"type":{"names":["String"]},"description":"a string to prepend to object keys","name":"prefix"},{"type":{"names":["Object"]},"description":"an object","name":"vars"}],"returns":[{"type":{"names":["Object"]},"description":"a modified object with prefixed keys"}],"longname":"module:makeThemeVars","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/makeThemeVars.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/makeThemeVars","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/makeThemeVars.ts').default","esPath":"@instructure/emotion/es/styleUtils/makeThemeVars","themePath":"packages/emotion/src/styleUtils/makeThemeVars.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/makeThemeVars.ts","id":"makeThemeVars","title":"makeThemeVars"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/matchComponentTypes.json b/pr-preview/pr-1690/docs/matchComponentTypes.json index 4cf4cf807e..f1f0aa6f7f 100644 --- a/pr-preview/pr-1690/docs/matchComponentTypes.json +++ b/pr-preview/pr-1690/docs/matchComponentTypes.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Check if a React component instance (React element) matches one of the\n * specified types.\n *\n * @module matchComponentTypes\n * @param {ReactElement|any} componentInstance\n * @param {Array} types an array of React components\n * @returns {Boolean} true if the component matches at least one of the types\n */","meta":{"filename":"u7h15binude2eiv0ot67d.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Check if a React component instance (React element) matches one of the\nspecified types.","kind":"module","name":"matchComponentTypes","params":[{"type":{"names":["ReactElement","any"]},"name":"componentInstance"},{"type":{"names":["Array"]},"description":"an array of React components","name":"types"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the component matches at least one of the types"}],"longname":"module:matchComponentTypes","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/matchComponentTypes.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/matchComponentTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/matchComponentTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/matchComponentTypes.ts').default","esPath":"@instructure/ui-react-utils/es/matchComponentTypes","themePath":"packages/ui-react-utils/src/matchComponentTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","id":"matchComponentTypes","title":"matchComponentTypes"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Check if a React component instance (React element) matches one of the\n * specified types.\n *\n * @module matchComponentTypes\n * @param {ReactElement|any} componentInstance\n * @param {Array} types an array of React components\n * @returns {Boolean} true if the component matches at least one of the types\n */","meta":{"filename":"oipnf9cjy7cdvwhtus04b5.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Check if a React component instance (React element) matches one of the\nspecified types.","kind":"module","name":"matchComponentTypes","params":[{"type":{"names":["ReactElement","any"]},"name":"componentInstance"},{"type":{"names":["Array"]},"description":"an array of React components","name":"types"}],"returns":[{"type":{"names":["Boolean"]},"description":"true if the component matches at least one of the types"}],"longname":"module:matchComponentTypes","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/matchComponentTypes.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/matchComponentTypes.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/matchComponentTypes","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/matchComponentTypes.ts').default","esPath":"@instructure/ui-react-utils/es/matchComponentTypes","themePath":"packages/ui-react-utils/src/matchComponentTypes.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/matchComponentTypes.ts","id":"matchComponentTypes","title":"matchComponentTypes"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/matchMedia.json b/pr-preview/pr-1690/docs/matchMedia.json index 0435a49b50..36b4c2a1d9 100644 --- a/pr-preview/pr-1690/docs/matchMedia.json +++ b/pr-preview/pr-1690/docs/matchMedia.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Wrapper function for window.matchMedia\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia\n * @module matchMedia\n * @param {string} query - media query string\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @returns {Object} a media query list object\n */","meta":{"filename":"hqqvr4t6w3rpdbgyqqpz5q.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nWrapper function for window.matchMedia\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia","kind":"module","name":"matchMedia","params":[{"type":{"names":["string"]},"description":"media query string","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Object"]},"description":"a media query list object"}],"longname":"module:matchMedia","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/matchMedia.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/matchMedia.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/matchMedia","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/matchMedia.ts').default","esPath":"@instructure/ui-dom-utils/es/matchMedia","themePath":"packages/ui-dom-utils/src/matchMedia.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","id":"matchMedia","title":"matchMedia"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Wrapper function for window.matchMedia\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia\n * @module matchMedia\n * @param {string} query - media query string\n * @param { Node | Window | React.ReactElement | React.Component | function } el - component or DOM node\n * @returns {Object} a media query list object\n */","meta":{"filename":"217bg8wwugtr7812yaz2q.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nWrapper function for window.matchMedia\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia","kind":"module","name":"matchMedia","params":[{"type":{"names":["string"]},"description":"media query string","name":"query"},{"type":{"names":["Node","Window","React.ReactElement","React.Component","function"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["Object"]},"description":"a media query list object"}],"longname":"module:matchMedia","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/matchMedia.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/matchMedia.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/matchMedia","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/matchMedia.ts').default","esPath":"@instructure/ui-dom-utils/es/matchMedia","themePath":"packages/ui-dom-utils/src/matchMedia.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/matchMedia.ts","id":"matchMedia","title":"matchMedia"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/mergeDeep.json b/pr-preview/pr-1690/docs/mergeDeep.json index 333b78a6bd..75cd9b6217 100644 --- a/pr-preview/pr-1690/docs/mergeDeep.json +++ b/pr-preview/pr-1690/docs/mergeDeep.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Deep merge N objects into a single result object.\n * Merging creates a new object, so that none of the arguments are modified.\n *\n * @module mergeDeep\n *\n * @param {Object} args objects to merge\n * @returns {Object} a new object with items from all arguments\n */","meta":{"filename":"as60w65oiojjrdtqh2wwj.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deep merge N objects into a single result object.\nMerging creates a new object, so that none of the arguments are modified.","kind":"module","name":"mergeDeep","params":[{"type":{"names":["Object"]},"description":"objects to merge","name":"args"}],"returns":[{"type":{"names":["Object"]},"description":"a new object with items from all arguments"}],"longname":"module:mergeDeep","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/mergeDeep.ts","extension":".ts","srcPath":"packages/ui-utils/src/mergeDeep.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/mergeDeep","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/mergeDeep.ts').default","esPath":"@instructure/ui-utils/es/mergeDeep","themePath":"packages/ui-utils/src/mergeDeep.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","id":"mergeDeep","title":"mergeDeep"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Deep merge N objects into a single result object.\n * Merging creates a new object, so that none of the arguments are modified.\n *\n * @module mergeDeep\n *\n * @param {Object} args objects to merge\n * @returns {Object} a new object with items from all arguments\n */","meta":{"filename":"ycwd3a6jjec02rgiebx.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Deep merge N objects into a single result object.\nMerging creates a new object, so that none of the arguments are modified.","kind":"module","name":"mergeDeep","params":[{"type":{"names":["Object"]},"description":"objects to merge","name":"args"}],"returns":[{"type":{"names":["Object"]},"description":"a new object with items from all arguments"}],"longname":"module:mergeDeep","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/mergeDeep.ts","extension":".ts","srcPath":"packages/ui-utils/src/mergeDeep.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/mergeDeep","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/mergeDeep.ts').default","esPath":"@instructure/ui-utils/es/mergeDeep","themePath":"packages/ui-utils/src/mergeDeep.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/mergeDeep.ts","id":"mergeDeep","title":"mergeDeep"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/mirrorPlacement.json b/pr-preview/pr-1690/docs/mirrorPlacement.json index 566154fee2..dbbfd49301 100644 --- a/pr-preview/pr-1690/docs/mirrorPlacement.json +++ b/pr-preview/pr-1690/docs/mirrorPlacement.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n * Given a string or array of one or two placement values, mirrors the placement\n * vertically or horizontally based on the first value.\n *\n * Examples\n * ```js-code\n * mirrorPlacement('top start') // input\n * ['bottom', 'start'] // output\n *\n * mirrorPlacement('top start', ' ') // input\n * 'bottom start' //output\n * ```\n *\n * @param {string|Array} placement - a string of the form '`` ``' or array [``, ``]\n * @param {string} delimiter - when provided, a value with which the result array will be joined\n * @returns {string|Array} - an array of values or, if the delimiter was supplied, a string of\n * delimiter separated values\n *\n * @module mirrorPlacement\n **/","meta":{"filename":"c7u2dvch4xr0s15hrhopud.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a string or array of one or two placement values, mirrors the placement\nvertically or horizontally based on the first value.\n\nExamples\n```js-code\nmirrorPlacement('top start') // input\n['bottom', 'start'] // output\n\nmirrorPlacement('top start', ' ') // input\n'bottom start' //output\n```","params":[{"type":{"names":["string","Array"]},"description":"a string of the form '`` ``' or array [``, ``]","name":"placement"},{"type":{"names":["string"]},"description":"when provided, a value with which the result array will be joined","name":"delimiter"}],"returns":[{"type":{"names":["string","Array"]},"description":"- an array of values or, if the delimiter was supplied, a string of\n delimiter separated values"}],"kind":"module","name":"mirrorPlacement","longname":"module:mirrorPlacement","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/mirrorPlacement.ts","extension":".ts","srcPath":"packages/ui-position/src/mirrorPlacement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/mirrorPlacement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/mirrorPlacement.ts').default","esPath":"@instructure/ui-position/es/mirrorPlacement","themePath":"packages/ui-position/src/mirrorPlacement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","id":"mirrorPlacement","title":"mirrorPlacement"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/position\n * ---\n * Given a string or array of one or two placement values, mirrors the placement\n * vertically or horizontally based on the first value.\n *\n * Examples\n * ```js-code\n * mirrorPlacement('top start') // input\n * ['bottom', 'start'] // output\n *\n * mirrorPlacement('top start', ' ') // input\n * 'bottom start' //output\n * ```\n *\n * @param {string|Array} placement - a string of the form '`` ``' or array [``, ``]\n * @param {string} delimiter - when provided, a value with which the result array will be joined\n * @returns {string|Array} - an array of values or, if the delimiter was supplied, a string of\n * delimiter separated values\n *\n * @module mirrorPlacement\n **/","meta":{"filename":"ylqfiyjij2zp76tqmwh5n.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Given a string or array of one or two placement values, mirrors the placement\nvertically or horizontally based on the first value.\n\nExamples\n```js-code\nmirrorPlacement('top start') // input\n['bottom', 'start'] // output\n\nmirrorPlacement('top start', ' ') // input\n'bottom start' //output\n```","params":[{"type":{"names":["string","Array"]},"description":"a string of the form '`` ``' or array [``, ``]","name":"placement"},{"type":{"names":["string"]},"description":"when provided, a value with which the result array will be joined","name":"delimiter"}],"returns":[{"type":{"names":["string","Array"]},"description":"- an array of values or, if the delimiter was supplied, a string of\n delimiter separated values"}],"kind":"module","name":"mirrorPlacement","longname":"module:mirrorPlacement","undocumented":false,"category":"utilities/position","relativePath":"packages/ui-position/src/mirrorPlacement.ts","extension":".ts","srcPath":"packages/ui-position/src/mirrorPlacement.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","packageName":"@instructure/ui-position","requirePath":"@instructure/ui-position/lib/mirrorPlacement","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-position/src/mirrorPlacement.ts').default","esPath":"@instructure/ui-position/es/mirrorPlacement","themePath":"packages/ui-position/src/mirrorPlacement.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-position/src/mirrorPlacement.ts","id":"mirrorPlacement","title":"mirrorPlacement"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/mirrorShorthand.json b/pr-preview/pr-1690/docs/mirrorShorthand.json index dc0044f1c4..046bcf09ba 100644 --- a/pr-preview/pr-1690/docs/mirrorShorthand.json +++ b/pr-preview/pr-1690/docs/mirrorShorthand.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * @module mirrorShorthand\n */","meta":{"filename":"q3242czv6rjxmlwpuhwyz.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"mirrorShorthand","longname":"module:mirrorShorthand","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/mirrorShorthand","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/mirrorShorthand.ts').default","esPath":"@instructure/emotion/es/styleUtils/mirrorShorthand","themePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","id":"mirrorShorthand","title":"mirrorShorthand"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n * @module mirrorShorthand\n */","meta":{"filename":"k6piej72iljf22acezwkuc.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"","kind":"module","name":"mirrorShorthand","longname":"module:mirrorShorthand","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","extension":".ts","srcPath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/styleUtils/mirrorShorthand","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/styleUtils/mirrorShorthand.ts').default","esPath":"@instructure/emotion/es/styleUtils/mirrorShorthand","themePath":"packages/emotion/src/styleUtils/mirrorShorthand.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/styleUtils/mirrorShorthand.ts","id":"mirrorShorthand","title":"mirrorShorthand"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/ms.json b/pr-preview/pr-1690/docs/ms.json index b80e3e6499..968b99c786 100644 --- a/pr-preview/pr-1690/docs/ms.json +++ b/pr-preview/pr-1690/docs/ms.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value time combination (s, ms) to a number representing ms\n *\n * @module ms\n *\n * Example inputs:\n * - '100s'\n * - '20ms'\n *\n * @param {String|Number} val\n * @returns {Number} Returns numerical representation of milliseconds\n */","meta":{"filename":"vj1c5aha3icdkzpzdxi5xr.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value time combination (s, ms) to a number representing ms","kind":"module","name":"ms\n\nExample inputs:\n - '100s'\n - '20ms'","params":[{"type":{"names":["String","Number"]},"name":"val"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of milliseconds"}],"longname":"ms\n\nExample inputs:\n - '100s'\n - '20ms'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/ms.ts","extension":".ts","srcPath":"packages/ui-utils/src/ms.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/ms","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/ms.ts').default","esPath":"@instructure/ui-utils/es/ms","themePath":"packages/ui-utils/src/ms.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","id":"ms","title":"ms"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value time combination (s, ms) to a number representing ms\n *\n * @module ms\n *\n * Example inputs:\n * - '100s'\n * - '20ms'\n *\n * @param {String|Number} val\n * @returns {Number} Returns numerical representation of milliseconds\n */","meta":{"filename":"6zdd5dsmya24tvp7yw0s1a.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value time combination (s, ms) to a number representing ms","kind":"module","name":"ms\n\nExample inputs:\n - '100s'\n - '20ms'","params":[{"type":{"names":["String","Number"]},"name":"val"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of milliseconds"}],"longname":"ms\n\nExample inputs:\n - '100s'\n - '20ms'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/ms.ts","extension":".ts","srcPath":"packages/ui-utils/src/ms.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/ms","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/ms.ts').default","esPath":"@instructure/ui-utils/es/ms","themePath":"packages/ui-utils/src/ms.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/ms.ts","id":"ms","title":"ms"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/omitProps.json b/pr-preview/pr-1690/docs/omitProps.json index fb784c518c..d88622445d 100644 --- a/pr-preview/pr-1690/docs/omitProps.json +++ b/pr-preview/pr-1690/docs/omitProps.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return an object with the remaining props after the given props are omitted.\n *\n * Automatically excludes the following props:\n * 'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'\n * @module omitProps\n * @param props The object to process\n * @param propsToOmit list disallowed prop keys or an object whose\n * keys will be omitted. If not specified the automatically excluded\n * props will be removed.\n * @param exclude an optional array of disallowed prop names to omit\n * @returns props object without the excluded props\n * @module omitProps\n */","meta":{"filename":"aqt2t1k2prnna5lv7iufm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return an object with the remaining props after the given props are omitted.\n\nAutomatically excludes the following props:\n'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'","kind":"module","name":"omitProps","params":[{"description":"The object to process","name":"props"},{"description":"list disallowed prop keys or an object whose\n keys will be omitted. If not specified the automatically excluded\n props will be removed.","name":"propsToOmit"},{"description":"an optional array of disallowed prop names to omit","name":"exclude"}],"returns":[{"description":"props object without the excluded props"}],"longname":"module:omitProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/omitProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/omitProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/omitProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/omitProps.ts').default","esPath":"@instructure/ui-react-utils/es/omitProps","themePath":"packages/ui-react-utils/src/omitProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","id":"omitProps","title":"omitProps"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return an object with the remaining props after the given props are omitted.\n *\n * Automatically excludes the following props:\n * 'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'\n * @module omitProps\n * @param props The object to process\n * @param propsToOmit list disallowed prop keys or an object whose\n * keys will be omitted. If not specified the automatically excluded\n * props will be removed.\n * @param exclude an optional array of disallowed prop names to omit\n * @returns props object without the excluded props\n * @module omitProps\n */","meta":{"filename":"9nujyt3eriqg95bslfzeil.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return an object with the remaining props after the given props are omitted.\n\nAutomatically excludes the following props:\n'theme', 'children', 'className', 'style', 'styles', 'makeStyles', 'themeOverride', 'deterministicId'","kind":"module","name":"omitProps","params":[{"description":"The object to process","name":"props"},{"description":"list disallowed prop keys or an object whose\n keys will be omitted. If not specified the automatically excluded\n props will be removed.","name":"propsToOmit"},{"description":"an optional array of disallowed prop names to omit","name":"exclude"}],"returns":[{"description":"props object without the excluded props"}],"longname":"module:omitProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/omitProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/omitProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/omitProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/omitProps.ts').default","esPath":"@instructure/ui-react-utils/es/omitProps","themePath":"packages/ui-react-utils/src/omitProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/omitProps.ts","id":"omitProps","title":"omitProps"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/ownerDocument.json b/pr-preview/pr-1690/docs/ownerDocument.json index 812b98fa0c..9b65f798f8 100644 --- a/pr-preview/pr-1690/docs/ownerDocument.json +++ b/pr-preview/pr-1690/docs/ownerDocument.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieve the owner document of a specified element\n * @module ownerDocument\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Document | null} the owner document\n */","meta":{"filename":"9lhmbmnzyh21aqc99yzzr.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieve the owner document of a specified element","kind":"module","name":"ownerDocument","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Document","null"]},"description":"the owner document"}],"longname":"module:ownerDocument","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerDocument.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerDocument.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerDocument","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerDocument.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerDocument","themePath":"packages/ui-dom-utils/src/ownerDocument.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","id":"ownerDocument","title":"ownerDocument"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * Retrieve the owner document of a specified element\n * @module ownerDocument\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Document | null} the owner document\n */","meta":{"filename":"99q64o9wjb7l2ykervxil.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nRetrieve the owner document of a specified element","kind":"module","name":"ownerDocument","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Document","null"]},"description":"the owner document"}],"longname":"module:ownerDocument","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerDocument.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerDocument.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerDocument","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerDocument.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerDocument","themePath":"packages/ui-dom-utils/src/ownerDocument.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerDocument.ts","id":"ownerDocument","title":"ownerDocument"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/ownerWindow.json b/pr-preview/pr-1690/docs/ownerWindow.json index c46278ff40..32137db131 100644 --- a/pr-preview/pr-1690/docs/ownerWindow.json +++ b/pr-preview/pr-1690/docs/ownerWindow.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Retrieve the owner window object associated with\n * the owner document of the specified element\n * @module ownerWindow\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Window | null } the owner window\n */","meta":{"filename":"y4bqtnnv7skkmunxm8h5j.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Retrieve the owner window object associated with\nthe owner document of the specified element","kind":"module","name":"ownerWindow","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Window","null"]},"description":"the owner window"}],"longname":"module:ownerWindow","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerWindow.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerWindow.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerWindow","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerWindow.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerWindow","themePath":"packages/ui-dom-utils/src/ownerWindow.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","id":"ownerWindow","title":"ownerWindow"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n * Retrieve the owner window object associated with\n * the owner document of the specified element\n * @module ownerWindow\n * @param { Node | Window | React.ReactElement | function | null } el\n * @returns { Window | null } the owner window\n */","meta":{"filename":"n20b52j9tok40e92nit3.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Retrieve the owner window object associated with\nthe owner document of the specified element","kind":"module","name":"ownerWindow","params":[{"type":{"names":["Node","Window","React.ReactElement","function","null"]},"name":"el"}],"returns":[{"type":{"names":["Window","null"]},"description":"the owner window"}],"longname":"module:ownerWindow","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/ownerWindow.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/ownerWindow.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/ownerWindow","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/ownerWindow.ts').default","esPath":"@instructure/ui-dom-utils/es/ownerWindow","themePath":"packages/ui-dom-utils/src/ownerWindow.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/ownerWindow.ts","id":"ownerWindow","title":"ownerWindow"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/parseQuery.json b/pr-preview/pr-1690/docs/parseQuery.json index 6518cf86ab..7736bc6cb4 100644 --- a/pr-preview/pr-1690/docs/parseQuery.json +++ b/pr-preview/pr-1690/docs/parseQuery.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a query and an element, return a function that takes\n * size as an argument and returns an object consisting of\n * query names and a boolean true false if it matches.\n * @module parseQuery\n * @param {Object} query - an object consisting of query names\n * mapped to individual queries\n * @param {Document | Window | Node | null} el - component or DOM node\n * @returns {function} takes size {width, height} as an argument\n * and returns an object consisting of query names and boolean\n * true false if it matches\n */","meta":{"filename":"yw2ixg8blgbgc1pf8bl0yl.js","lineno":5,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a query and an element, return a function that takes\nsize as an argument and returns an object consisting of\nquery names and a boolean true false if it matches.","kind":"module","name":"parseQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of query names\n mapped to individual queries","name":"query"},{"type":{"names":["Document","Window","Node","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["function"]},"description":"takes size {width, height} as an argument\n and returns an object consisting of query names and boolean\n true false if it matches"}],"longname":"module:parseQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/parseQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/parseQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/parseQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/parseQuery.ts').default","esPath":"@instructure/ui-responsive/es/parseQuery","themePath":"packages/ui-responsive/src/parseQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","id":"parseQuery","title":"parseQuery"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/layout\n * ---\n *\n * Given a query and an element, return a function that takes\n * size as an argument and returns an object consisting of\n * query names and a boolean true false if it matches.\n * @module parseQuery\n * @param {Object} query - an object consisting of query names\n * mapped to individual queries\n * @param {Document | Window | Node | null} el - component or DOM node\n * @returns {function} takes size {width, height} as an argument\n * and returns an object consisting of query names and boolean\n * true false if it matches\n */","meta":{"filename":"6dpojoyv907clhqgletr4.js","lineno":5,"columnno":0,"path":"/tmp","code":{}},"description":"\nGiven a query and an element, return a function that takes\nsize as an argument and returns an object consisting of\nquery names and a boolean true false if it matches.","kind":"module","name":"parseQuery","params":[{"type":{"names":["Object"]},"description":"an object consisting of query names\n mapped to individual queries","name":"query"},{"type":{"names":["Document","Window","Node","null"]},"description":"component or DOM node","name":"el"}],"returns":[{"type":{"names":["function"]},"description":"takes size {width, height} as an argument\n and returns an object consisting of query names and boolean\n true false if it matches"}],"longname":"module:parseQuery","undocumented":false,"category":"utilities/layout","relativePath":"packages/ui-responsive/src/parseQuery.ts","extension":".ts","srcPath":"packages/ui-responsive/src/parseQuery.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","packageName":"@instructure/ui-responsive","requirePath":"@instructure/ui-responsive/lib/parseQuery","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-responsive/src/parseQuery.ts').default","esPath":"@instructure/ui-responsive/es/parseQuery","themePath":"packages/ui-responsive/src/parseQuery.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-responsive/src/parseQuery.ts","id":"parseQuery","title":"parseQuery"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/parseUnit.json b/pr-preview/pr-1690/docs/parseUnit.json index fb2174dffd..62de5f822f 100644 --- a/pr-preview/pr-1690/docs/parseUnit.json +++ b/pr-preview/pr-1690/docs/parseUnit.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a CSS unit value combination into an array of type [ value, unit ]\n *\n * @module parseUnit\n *\n * Example inputs:\n * - '100px'\n * - '20rem'\n * - '10vh'\n * - '400vmin'\n *\n * @param {string|number} str\n * @returns {Array} Returns array of shape [ value, unit ] Unit is '' if it could\n * not be parsed\n */","meta":{"filename":"wnszznf6klga566j6912r.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a CSS unit value combination into an array of type [ value, unit ]","kind":"module","name":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'","params":[{"type":{"names":["string","number"]},"name":"str"}],"returns":[{"type":{"names":["Array"]},"description":"Returns array of shape [ value, unit ] Unit is '' if it could\nnot be parsed"}],"longname":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/parseUnit.ts","extension":".ts","srcPath":"packages/ui-utils/src/parseUnit.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/parseUnit","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/parseUnit.ts').default","esPath":"@instructure/ui-utils/es/parseUnit","themePath":"packages/ui-utils/src/parseUnit.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","id":"parseUnit","title":"parseUnit"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a CSS unit value combination into an array of type [ value, unit ]\n *\n * @module parseUnit\n *\n * Example inputs:\n * - '100px'\n * - '20rem'\n * - '10vh'\n * - '400vmin'\n *\n * @param {string|number} str\n * @returns {Array} Returns array of shape [ value, unit ] Unit is '' if it could\n * not be parsed\n */","meta":{"filename":"flz8k38n4zwuqzyumk3qym.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a CSS unit value combination into an array of type [ value, unit ]","kind":"module","name":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'","params":[{"type":{"names":["string","number"]},"name":"str"}],"returns":[{"type":{"names":["Array"]},"description":"Returns array of shape [ value, unit ] Unit is '' if it could\nnot be parsed"}],"longname":"parseUnit\n\nExample inputs:\n - '100px'\n - '20rem'\n - '10vh'\n - '400vmin'module:","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/parseUnit.ts","extension":".ts","srcPath":"packages/ui-utils/src/parseUnit.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/parseUnit","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/parseUnit.ts').default","esPath":"@instructure/ui-utils/es/parseUnit","themePath":"packages/ui-utils/src/parseUnit.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/parseUnit.ts","id":"parseUnit","title":"parseUnit"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/pascalize.json b/pr-preview/pr-1690/docs/pascalize.json index 6d4cd66633..16341b7c69 100644 --- a/pr-preview/pr-1690/docs/pascalize.json +++ b/pr-preview/pr-1690/docs/pascalize.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a hyphenated or camel cased string to pascal case\n *\n * Example inputs:\n * - 'foo-bar'\n * - 'baz-qux'\n *\n * Example outputs:\n * - 'FooBar'\n * - 'BazQux'\n *\n * @module pascalize\n * @param {String} str\n * @returns {String} Returns pascal cased string\n */","meta":{"filename":"ycaqebsuuxrlzxp0qsfm2.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a hyphenated or camel cased string to pascal case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'FooBar'\n - 'BazQux'","kind":"module","name":"pascalize","params":[{"type":{"names":["String"]},"name":"str"}],"returns":[{"type":{"names":["String"]},"description":"Returns pascal cased string"}],"longname":"module:pascalize","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/pascalize.ts","extension":".ts","srcPath":"packages/ui-utils/src/pascalize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/pascalize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/pascalize.ts').default","esPath":"@instructure/ui-utils/es/pascalize","themePath":"packages/ui-utils/src/pascalize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","id":"pascalize","title":"pascalize"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a hyphenated or camel cased string to pascal case\n *\n * Example inputs:\n * - 'foo-bar'\n * - 'baz-qux'\n *\n * Example outputs:\n * - 'FooBar'\n * - 'BazQux'\n *\n * @module pascalize\n * @param {String} str\n * @returns {String} Returns pascal cased string\n */","meta":{"filename":"vprwmpojwb421wir1aoyo.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a hyphenated or camel cased string to pascal case\n\nExample inputs:\n - 'foo-bar'\n - 'baz-qux'\n\nExample outputs:\n - 'FooBar'\n - 'BazQux'","kind":"module","name":"pascalize","params":[{"type":{"names":["String"]},"name":"str"}],"returns":[{"type":{"names":["String"]},"description":"Returns pascal cased string"}],"longname":"module:pascalize","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/pascalize.ts","extension":".ts","srcPath":"packages/ui-utils/src/pascalize.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/pascalize","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/pascalize.ts').default","esPath":"@instructure/ui-utils/es/pascalize","themePath":"packages/ui-utils/src/pascalize.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/pascalize.ts","id":"pascalize","title":"pascalize"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/pickProps.json b/pr-preview/pr-1690/docs/pickProps.json index 925775247a..565a101c7f 100644 --- a/pr-preview/pr-1690/docs/pickProps.json +++ b/pr-preview/pr-1690/docs/pickProps.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return a props object with only specified propTypes.\n * @module pickProps\n * @param {Object} props React component props\n * @param {Object|Array} propTypesOrAllowedPropList React component propTypes or the list of allowed prop keys\n * @param {Array} include an optional array of prop names to include\n * @returns {Object} props object with only the included props\n * @module pickProps\n */","meta":{"filename":"rbulyxlzcbw3kd5vc5vv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return a props object with only specified propTypes.","kind":"module","name":"pickProps","params":[{"type":{"names":["Object"]},"description":"React component props","name":"props"},{"type":{"names":["Object","Array."]},"description":"React component propTypes or the list of allowed prop keys","name":"propTypesOrAllowedPropList"},{"type":{"names":["Array"]},"description":"an optional array of prop names to include","name":"include"}],"returns":[{"type":{"names":["Object"]},"description":"props object with only the included props"}],"longname":"module:pickProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/pickProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/pickProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/pickProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/pickProps.ts').default","esPath":"@instructure/ui-react-utils/es/pickProps","themePath":"packages/ui-react-utils/src/pickProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","id":"pickProps","title":"pickProps"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * Return a props object with only specified propTypes.\n * @module pickProps\n * @param {Object} props React component props\n * @param {Object|Array} propTypesOrAllowedPropList React component propTypes or the list of allowed prop keys\n * @param {Array} include an optional array of prop names to include\n * @returns {Object} props object with only the included props\n * @module pickProps\n */","meta":{"filename":"n1ikmmncgzhghq3hnrjjsl.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Return a props object with only specified propTypes.","kind":"module","name":"pickProps","params":[{"type":{"names":["Object"]},"description":"React component props","name":"props"},{"type":{"names":["Object","Array."]},"description":"React component propTypes or the list of allowed prop keys","name":"propTypesOrAllowedPropList"},{"type":{"names":["Array"]},"description":"an optional array of prop names to include","name":"include"}],"returns":[{"type":{"names":["Object"]},"description":"props object with only the included props"}],"longname":"module:pickProps","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/pickProps.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/pickProps.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/pickProps","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/pickProps.ts').default","esPath":"@instructure/ui-react-utils/es/pickProps","themePath":"packages/ui-react-utils/src/pickProps.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/pickProps.ts","id":"pickProps","title":"pickProps"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/px.json b/pr-preview/pr-1690/docs/px.json index f1b237f32b..6bde2c027c 100644 --- a/pr-preview/pr-1690/docs/px.json +++ b/pr-preview/pr-1690/docs/px.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value size combination (em, rem, px) to a number representing px\n *\n * Example inputs:\n * - '100rem'\n * - '20em'\n * - '40px'\n *\n * @module px\n *\n * @param {String|number} val The value to look up. If it's a number its just returned as is.\n * @param {Document|Window|Node|React.ReactElement |React.Component|null} el - containing element, for context measure is em (defaults to `document.body`)\n * @returns {Number} Returns numerical representation of pixels\n */","meta":{"filename":"o96mplwrssjk87qihdde.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value size combination (em, rem, px) to a number representing px\n\nExample inputs:\n - '100rem'\n - '20em'\n - '40px'","kind":"module","name":"px","params":[{"type":{"names":["String","number"]},"description":"The value to look up. If it's a number its just returned as is.","name":"val"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component","null"]},"description":"containing element, for context measure is em (defaults to `document.body`)","name":"el"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of pixels"}],"longname":"module:px","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/px.ts","extension":".ts","srcPath":"packages/ui-utils/src/px.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/px","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/px.ts').default","esPath":"@instructure/ui-utils/es/px","themePath":"packages/ui-utils/src/px.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","id":"px","title":"px"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Converts a unit value size combination (em, rem, px) to a number representing px\n *\n * Example inputs:\n * - '100rem'\n * - '20em'\n * - '40px'\n *\n * @module px\n *\n * @param {String|number} val The value to look up. If it's a number its just returned as is.\n * @param {Document|Window|Node|React.ReactElement |React.Component|null} el - containing element, for context measure is em (defaults to `document.body`)\n * @returns {Number} Returns numerical representation of pixels\n */","meta":{"filename":"ddh2ieknk8n0bty59k314y.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Converts a unit value size combination (em, rem, px) to a number representing px\n\nExample inputs:\n - '100rem'\n - '20em'\n - '40px'","kind":"module","name":"px","params":[{"type":{"names":["String","number"]},"description":"The value to look up. If it's a number its just returned as is.","name":"val"},{"type":{"names":["Document","Window","Node","React.ReactElement","React.Component","null"]},"description":"containing element, for context measure is em (defaults to `document.body`)","name":"el"}],"returns":[{"type":{"names":["Number"]},"description":"Returns numerical representation of pixels"}],"longname":"module:px","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/px.ts","extension":".ts","srcPath":"packages/ui-utils/src/px.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/px","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/px.ts').default","esPath":"@instructure/ui-utils/es/px","themePath":"packages/ui-utils/src/px.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/px.ts","id":"px","title":"px"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/requestAnimationFrame.json b/pr-preview/pr-1690/docs/requestAnimationFrame.json index 379517555c..02bb766048 100644 --- a/pr-preview/pr-1690/docs/requestAnimationFrame.json +++ b/pr-preview/pr-1690/docs/requestAnimationFrame.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * If DOM is usable, returns a function wrapper for\n * window.requestAnimationFrame. Otherwise sets\n * a manual timeout.\n * @module requestAnimationFrame\n *\n * @returns {function} requestAnimationFrame takes a callback function as an argument and returns a cancel method\n */","meta":{"filename":"cjmjedin3phk8f67ha5r9g.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nIf DOM is usable, returns a function wrapper for\nwindow.requestAnimationFrame. Otherwise sets\na manual timeout.","kind":"module","name":"requestAnimationFrame","returns":[{"type":{"names":["function"]},"description":"requestAnimationFrame takes a callback function as an argument and returns a cancel method"}],"longname":"module:requestAnimationFrame","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/requestAnimationFrame","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/requestAnimationFrame.ts').default","esPath":"@instructure/ui-dom-utils/es/requestAnimationFrame","themePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","id":"requestAnimationFrame","title":"requestAnimationFrame"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * If DOM is usable, returns a function wrapper for\n * window.requestAnimationFrame. Otherwise sets\n * a manual timeout.\n * @module requestAnimationFrame\n *\n * @returns {function} requestAnimationFrame takes a callback function as an argument and returns a cancel method\n */","meta":{"filename":"slcp7qv14qj72v4pcepsm.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nIf DOM is usable, returns a function wrapper for\nwindow.requestAnimationFrame. Otherwise sets\na manual timeout.","kind":"module","name":"requestAnimationFrame","returns":[{"type":{"names":["function"]},"description":"requestAnimationFrame takes a callback function as an argument and returns a cancel method"}],"longname":"module:requestAnimationFrame","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/requestAnimationFrame","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/requestAnimationFrame.ts').default","esPath":"@instructure/ui-dom-utils/es/requestAnimationFrame","themePath":"packages/ui-dom-utils/src/requestAnimationFrame.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/requestAnimationFrame.ts","id":"requestAnimationFrame","title":"requestAnimationFrame"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/scopeTab.json b/pr-preview/pr-1690/docs/scopeTab.json index 880e127acc..65b34916e2 100644 --- a/pr-preview/pr-1690/docs/scopeTab.json +++ b/pr-preview/pr-1690/docs/scopeTab.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Scope tab in order to trap focus within a specified\n * element.\n * @module scopeTab\n * @param {ReactElement|DOMNode} element\n * @param {Event} event the DOM Event that was fired\n * @param {function} function executed when leaving final tabbable instead of the default behavior\n */","meta":{"filename":"yhabi43xz4izkyxyoiyn6.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nScope tab in order to trap focus within a specified\nelement.","kind":"module","name":"scopeTab","params":[{"type":{"names":["ReactElement","DOMNode"]},"name":"element"},{"type":{"names":["Event"]},"description":"the DOM Event that was fired","name":"event"},{"type":{"names":["function"]},"description":"executed when leaving final tabbable instead of the default behavior","name":"function"}],"longname":"module:scopeTab","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/scopeTab.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/scopeTab.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/scopeTab","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/scopeTab.ts').default","esPath":"@instructure/ui-a11y-utils/es/scopeTab","themePath":"packages/ui-a11y-utils/src/scopeTab.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","id":"scopeTab","title":"scopeTab"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/a11y\n * ---\n *\n * Scope tab in order to trap focus within a specified\n * element.\n * @module scopeTab\n * @param {ReactElement|DOMNode} element\n * @param {Event} event the DOM Event that was fired\n * @param {function} function executed when leaving final tabbable instead of the default behavior\n */","meta":{"filename":"ml2xkf9y6uscu1x26c622u.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nScope tab in order to trap focus within a specified\nelement.","kind":"module","name":"scopeTab","params":[{"type":{"names":["ReactElement","DOMNode"]},"name":"element"},{"type":{"names":["Event"]},"description":"the DOM Event that was fired","name":"event"},{"type":{"names":["function"]},"description":"executed when leaving final tabbable instead of the default behavior","name":"function"}],"longname":"module:scopeTab","undocumented":false,"category":"utilities/a11y","relativePath":"packages/ui-a11y-utils/src/scopeTab.ts","extension":".ts","srcPath":"packages/ui-a11y-utils/src/scopeTab.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","packageName":"@instructure/ui-a11y-utils","requirePath":"@instructure/ui-a11y-utils/lib/scopeTab","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-a11y-utils/src/scopeTab.ts').default","esPath":"@instructure/ui-a11y-utils/es/scopeTab","themePath":"packages/ui-a11y-utils/src/scopeTab.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-a11y-utils/src/scopeTab.ts","id":"scopeTab","title":"scopeTab"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/shallowEqual.json b/pr-preview/pr-1690/docs/shallowEqual.json index dd0330cfff..bc4882ee7a 100644 --- a/pr-preview/pr-1690/docs/shallowEqual.json +++ b/pr-preview/pr-1690/docs/shallowEqual.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Performs equality by iterating through keys on an object and returning false\n * when any key has values which are not strictly equal between the arguments.\n *\n * @module shallowEqual\n *\n * @param {Object} objA\n * @param {Object} objB\n * @returns {Boolean} Returns true when the values of all keys are strictly equal\n */","meta":{"filename":"jjnxi32lbx310dykagzjq.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Performs equality by iterating through keys on an object and returning false\nwhen any key has values which are not strictly equal between the arguments.","kind":"module","name":"shallowEqual","params":[{"type":{"names":["Object"]},"name":"objA"},{"type":{"names":["Object"]},"name":"objB"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true when the values of all keys are strictly equal"}],"longname":"module:shallowEqual","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/shallowEqual.ts","extension":".ts","srcPath":"packages/ui-utils/src/shallowEqual.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/shallowEqual","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/shallowEqual.ts').default","esPath":"@instructure/ui-utils/es/shallowEqual","themePath":"packages/ui-utils/src/shallowEqual.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","id":"shallowEqual","title":"shallowEqual"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Performs equality by iterating through keys on an object and returning false\n * when any key has values which are not strictly equal between the arguments.\n *\n * @module shallowEqual\n *\n * @param {Object} objA\n * @param {Object} objB\n * @returns {Boolean} Returns true when the values of all keys are strictly equal\n */","meta":{"filename":"f86k4qskgp4ah6dk4mr4n8.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Performs equality by iterating through keys on an object and returning false\nwhen any key has values which are not strictly equal between the arguments.","kind":"module","name":"shallowEqual","params":[{"type":{"names":["Object"]},"name":"objA"},{"type":{"names":["Object"]},"name":"objB"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true when the values of all keys are strictly equal"}],"longname":"module:shallowEqual","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/shallowEqual.ts","extension":".ts","srcPath":"packages/ui-utils/src/shallowEqual.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/shallowEqual","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/shallowEqual.ts').default","esPath":"@instructure/ui-utils/es/shallowEqual","themePath":"packages/ui-utils/src/shallowEqual.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/shallowEqual.ts","id":"shallowEqual","title":"shallowEqual"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/textDirectionContextConsumer.json b/pr-preview/pr-1690/docs/textDirectionContextConsumer.json index 8adfc94f4a..f9d0e858ed 100644 --- a/pr-preview/pr-1690/docs/textDirectionContextConsumer.json +++ b/pr-preview/pr-1690/docs/textDirectionContextConsumer.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * A decorator or higher order component that supplies the text direction to\n * components.\n *\n * As a HOC:\n *\n * ```js-code\n * import { textDirectionContextConsumer } from '@instructure/ui-i18n'\n *\n * class Example extends React.Component {\n * render () {\n * return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n * }\n * }\n *\n * export default textDirectionContextConsumer()(Example)\n * ```\n *\n * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\n * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\n * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\n * textDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\n * if it is not present.\n *\n * @module textDirectionContextConsumer\n * @return The decorator that composes the textDirectionContextConsumer component.\n */","meta":{"filename":"enqcjjn5nckpzoxcajmsoo.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that supplies the text direction to\ncomponents.\n\nAs a HOC:\n\n```js-code\nimport { textDirectionContextConsumer } from '@instructure/ui-i18n'\n\nclass Example extends React.Component {\n render () {\n return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n }\n}\n\nexport default textDirectionContextConsumer()(Example)\n```\n\nWhen used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\nthe direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\nthe direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\ntextDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\nif it is not present.","kind":"module","name":"textDirectionContextConsumer","returns":[{"description":"The decorator that composes the textDirectionContextConsumer component."}],"longname":"module:textDirectionContextConsumer","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","extension":".tsx","srcPath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/textDirectionContextConsumer","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/textDirectionContextConsumer.tsx').default","esPath":"@instructure/ui-i18n/es/textDirectionContextConsumer","themePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","id":"textDirectionContextConsumer","title":"textDirectionContextConsumer"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/i18n\n * ---\n *\n * A decorator or higher order component that supplies the text direction to\n * components.\n *\n * As a HOC:\n *\n * ```js-code\n * import { textDirectionContextConsumer } from '@instructure/ui-i18n'\n *\n * class Example extends React.Component {\n * render () {\n * return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n * }\n * }\n *\n * export default textDirectionContextConsumer()(Example)\n * ```\n *\n * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\n * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\n * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\n * textDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\n * if it is not present.\n *\n * @module textDirectionContextConsumer\n * @return The decorator that composes the textDirectionContextConsumer component.\n */","meta":{"filename":"n8kwowq0bsaqwmo9prd2n.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that supplies the text direction to\ncomponents.\n\nAs a HOC:\n\n```js-code\nimport { textDirectionContextConsumer } from '@instructure/ui-i18n'\n\nclass Example extends React.Component {\n render () {\n return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ?
rtl
:
ltr
\n }\n}\n\nexport default textDirectionContextConsumer()(Example)\n```\n\nWhen used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer components use\nthe direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),\nthe direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,\ntextDirectionContextConsumer components query the documentElement for the `dir` attribute, defaulting to `ltr`\nif it is not present.","kind":"module","name":"textDirectionContextConsumer","returns":[{"description":"The decorator that composes the textDirectionContextConsumer component."}],"longname":"module:textDirectionContextConsumer","undocumented":false,"category":"utilities/i18n","relativePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","extension":".tsx","srcPath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","packageName":"@instructure/ui-i18n","requirePath":"@instructure/ui-i18n/lib/textDirectionContextConsumer","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-i18n/src/textDirectionContextConsumer.tsx').default","esPath":"@instructure/ui-i18n/es/textDirectionContextConsumer","themePath":"packages/ui-i18n/src/textDirectionContextConsumer.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-i18n/src/textDirectionContextConsumer.tsx","id":"textDirectionContextConsumer","title":"textDirectionContextConsumer"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/transformSelection.json b/pr-preview/pr-1690/docs/transformSelection.json index 91101cbfe9..f4f153bfbe 100644 --- a/pr-preview/pr-1690/docs/transformSelection.json +++ b/pr-preview/pr-1690/docs/transformSelection.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * transformSelection - Calculate the resulting text selection\n * of a changing text-containing HTML element\n * @module transformSelection\n * @param {HTMLElement} element - HTML element with selection capabilities\n * @param {string} cleanedValue - new value that will be given to the HTML element\n * @return {Object} resulting selection values\n */","meta":{"filename":"q4nduzv06krtn0z2z1y5yn.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\ntransformSelection - Calculate the resulting text selection\nof a changing text-containing HTML element","kind":"module","name":"transformSelection","params":[{"type":{"names":["HTMLElement"]},"description":"HTML element with selection capabilities","name":"element"},{"type":{"names":["string"]},"description":"new value that will be given to the HTML element","name":"cleanedValue"}],"returns":[{"type":{"names":["Object"]},"description":"resulting selection values"}],"longname":"module:transformSelection","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/transformSelection.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/transformSelection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/transformSelection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/transformSelection.ts').default","esPath":"@instructure/ui-dom-utils/es/transformSelection","themePath":"packages/ui-dom-utils/src/transformSelection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","id":"transformSelection","title":"transformSelection"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/DOM\n * ---\n *\n * transformSelection - Calculate the resulting text selection\n * of a changing text-containing HTML element\n * @module transformSelection\n * @param {HTMLElement} element - HTML element with selection capabilities\n * @param {string} cleanedValue - new value that will be given to the HTML element\n * @return {Object} resulting selection values\n */","meta":{"filename":"xzx9dsyhn0pp3l5rb9jnt.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\ntransformSelection - Calculate the resulting text selection\nof a changing text-containing HTML element","kind":"module","name":"transformSelection","params":[{"type":{"names":["HTMLElement"]},"description":"HTML element with selection capabilities","name":"element"},{"type":{"names":["string"]},"description":"new value that will be given to the HTML element","name":"cleanedValue"}],"returns":[{"type":{"names":["Object"]},"description":"resulting selection values"}],"longname":"module:transformSelection","undocumented":false,"category":"utilities/DOM","relativePath":"packages/ui-dom-utils/src/transformSelection.ts","extension":".ts","srcPath":"packages/ui-dom-utils/src/transformSelection.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","packageName":"@instructure/ui-dom-utils","requirePath":"@instructure/ui-dom-utils/lib/transformSelection","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-dom-utils/src/transformSelection.ts').default","esPath":"@instructure/ui-dom-utils/es/transformSelection","themePath":"packages/ui-dom-utils/src/transformSelection.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-dom-utils/src/transformSelection.ts","id":"transformSelection","title":"transformSelection"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/uid.json b/pr-preview/pr-1690/docs/uid.json index 60f81099f5..1e6f08bf20 100644 --- a/pr-preview/pr-1690/docs/uid.json +++ b/pr-preview/pr-1690/docs/uid.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Generate a unique (CSS-safe) id string\n *\n * @module uid\n * @param {String} prefix a string to prefix the id for debugging in non-production env\n * @param {Number} length id length (in characters, minus the prefix). Default is 12\n * @returns {String} a unique id\n */","meta":{"filename":"eg2dnzxk40cv9x9ibg31y.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Generate a unique (CSS-safe) id string","kind":"module","name":"uid","params":[{"type":{"names":["String"]},"description":"a string to prefix the id for debugging in non-production env","name":"prefix"},{"type":{"names":["Number"]},"description":"id length (in characters, minus the prefix). Default is 12","name":"length"}],"returns":[{"type":{"names":["String"]},"description":"a unique id"}],"longname":"module:uid","undocumented":false,"category":"utilities","relativePath":"packages/uid/src/uid.ts","extension":".ts","srcPath":"packages/uid/src/uid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","packageName":"@instructure/uid","requirePath":"@instructure/uid/lib/uid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/uid/src/uid.ts').default","esPath":"@instructure/uid/es/uid","themePath":"packages/uid/src/uid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","id":"uid","title":"uid"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Generate a unique (CSS-safe) id string\n *\n * @module uid\n * @param {String} prefix a string to prefix the id for debugging in non-production env\n * @param {Number} length id length (in characters, minus the prefix). Default is 12\n * @returns {String} a unique id\n */","meta":{"filename":"oapyshm1bcp7y0tqkrsxzn.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Generate a unique (CSS-safe) id string","kind":"module","name":"uid","params":[{"type":{"names":["String"]},"description":"a string to prefix the id for debugging in non-production env","name":"prefix"},{"type":{"names":["Number"]},"description":"id length (in characters, minus the prefix). Default is 12","name":"length"}],"returns":[{"type":{"names":["String"]},"description":"a unique id"}],"longname":"module:uid","undocumented":false,"category":"utilities","relativePath":"packages/uid/src/uid.ts","extension":".ts","srcPath":"packages/uid/src/uid.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","packageName":"@instructure/uid","requirePath":"@instructure/uid/lib/uid","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/uid/src/uid.ts').default","esPath":"@instructure/uid/es/uid","themePath":"packages/uid/src/uid.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/uid/src/uid.ts","id":"uid","title":"uid"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/windowMessageListener.json b/pr-preview/pr-1690/docs/windowMessageListener.json index df77dcf9ee..c5ef7da3ef 100644 --- a/pr-preview/pr-1690/docs/windowMessageListener.json +++ b/pr-preview/pr-1690/docs/windowMessageListener.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * A decorator or higher order component that provides methods\n * for cross-origin communication (between iframes/windows).\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage\n * @module windowMessageListener\n * @param {Function} messageHandler a handler for messages receieved by the component\n * @param {Function} validSource an optional function that would restrict message handling to a specified source.\n * @returns {Function} a function that decorates a React component with the behavior\n */","meta":{"filename":"vmrtqcu9x9ryg5j5lkws1b.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A decorator or higher order component that provides methods\nfor cross-origin communication (between iframes/windows).\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage","kind":"module","name":"windowMessageListener","params":[{"type":{"names":["function"]},"description":"a handler for messages receieved by the component","name":"messageHandler"},{"type":{"names":["function"]},"description":"an optional function that would restrict message handling to a specified source.","name":"validSource"}],"returns":[{"type":{"names":["function"]},"description":"a function that decorates a React component with the behavior"}],"longname":"module:windowMessageListener","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/windowMessageListener.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/windowMessageListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/windowMessageListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/windowMessageListener.ts').default","esPath":"@instructure/ui-react-utils/es/windowMessageListener","themePath":"packages/ui-react-utils/src/windowMessageListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","id":"windowMessageListener","title":"windowMessageListener"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/react\n * ---\n * A decorator or higher order component that provides methods\n * for cross-origin communication (between iframes/windows).\n *\n * see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage\n * @module windowMessageListener\n * @param {Function} messageHandler a handler for messages receieved by the component\n * @param {Function} validSource an optional function that would restrict message handling to a specified source.\n * @returns {Function} a function that decorates a React component with the behavior\n */","meta":{"filename":"0a3oxoe8n2u5bdfybmpg6v.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"A decorator or higher order component that provides methods\nfor cross-origin communication (between iframes/windows).\n\nsee https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage","kind":"module","name":"windowMessageListener","params":[{"type":{"names":["function"]},"description":"a handler for messages receieved by the component","name":"messageHandler"},{"type":{"names":["function"]},"description":"an optional function that would restrict message handling to a specified source.","name":"validSource"}],"returns":[{"type":{"names":["function"]},"description":"a function that decorates a React component with the behavior"}],"longname":"module:windowMessageListener","undocumented":false,"category":"utilities/react","relativePath":"packages/ui-react-utils/src/windowMessageListener.ts","extension":".ts","srcPath":"packages/ui-react-utils/src/windowMessageListener.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","packageName":"@instructure/ui-react-utils","requirePath":"@instructure/ui-react-utils/lib/windowMessageListener","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-react-utils/src/windowMessageListener.ts').default","esPath":"@instructure/ui-react-utils/es/windowMessageListener","themePath":"packages/ui-react-utils/src/windowMessageListener.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-react-utils/src/windowMessageListener.ts","id":"windowMessageListener","title":"windowMessageListener"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/withStyle.json b/pr-preview/pr-1690/docs/withStyle.json index 3813c579f4..37dd43018d 100644 --- a/pr-preview/pr-1690/docs/withStyle.json +++ b/pr-preview/pr-1690/docs/withStyle.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n *\n * A decorator or higher order component that makes a component themeable.\n *\n * It adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n *\n * As a HOC:\n *\n * ```js-code\n * import { withStyle, jsx } from '@instructure/emotion'\n * import generateStyle from './styles'\n * import generateComponentTheme from './theme'\n *\n * export default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n * ```\n *\n * Themeable components inject their themed styles into the document\n * when they are mounted.\n *\n * ### Applying themes\n *\n * A themeable component’s theme can be configured via wrapping it in an\n * [InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\n * explicitly via its `themeOverride` prop.\n *\n * InstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\n * These variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n *\n * With the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n *\n * See more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n *\n * ```js-code\n * // ExampleComponent/theme.js\n * const generateComponentTheme = (theme) => {\n * const { colors } = theme\n *\n * const componentVariables = {\n * background: colors?.backgroundMedium,\n * color: colors?.textDarkest,\n *\n * hoverColor: colors?.textLightest,\n * hoverBackground: colors?.backgroundDarkest\n * }\n *\n * return componentVariables\n * }\n * export default generateComponentTheme\n * ```\n *\n * ```jsx-code\n * {// global theme override}\n * \n * {// component theme override}\n * \n *\n * {// component theme override with function}\n * ({\n * hoverBackground: componentTheme.background,\n * activeBackground: currentTheme.colors.backgroundBrand\n * })} />\n * \n * ```\n *\n * @module withStyle\n *\n * @param {function} generateStyle - The function that returns the component's style object\n * @param {function} generateComponentTheme - The function that returns the component's theme variables object\n * @returns {ReactElement} The decorated WithStyle Component\n */","meta":{"filename":"t25b9ssv8jegy30tlkmmuw.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that makes a component themeable.\n\nIt adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n\nAs a HOC:\n\n```js-code\nimport { withStyle, jsx } from '@instructure/emotion'\nimport generateStyle from './styles'\nimport generateComponentTheme from './theme'\n\nexport default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n```\n\nThemeable components inject their themed styles into the document\nwhen they are mounted.\n\n### Applying themes\n\nA themeable component’s theme can be configured via wrapping it in an\n[InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\nexplicitly via its `themeOverride` prop.\n\nInstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\nThese variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n\nWith the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n\nSee more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n\n```js-code\n// ExampleComponent/theme.js\nconst generateComponentTheme = (theme) => {\n const { colors } = theme\n\n const componentVariables = {\n background: colors?.backgroundMedium,\n color: colors?.textDarkest,\n\n hoverColor: colors?.textLightest,\n hoverBackground: colors?.backgroundDarkest\n }\n\n return componentVariables\n}\nexport default generateComponentTheme\n```\n\n```jsx-code\n{// global theme override}\n\n {// component theme override}\n \n\n {// component theme override with function}\n ({\n hoverBackground: componentTheme.background,\n activeBackground: currentTheme.colors.backgroundBrand\n })} />\n\n```","kind":"module","name":"withStyle","params":[{"type":{"names":["function"]},"description":"The function that returns the component's style object","name":"generateStyle"},{"type":{"names":["function"]},"description":"The function that returns the component's theme variables object","name":"generateComponentTheme"}],"returns":[{"type":{"names":["ReactElement"]},"description":"The decorated WithStyle Component"}],"longname":"module:withStyle","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/withStyle.tsx","extension":".tsx","srcPath":"packages/emotion/src/withStyle.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/withStyle","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/withStyle.tsx').default","esPath":"@instructure/emotion/es/withStyle","themePath":"packages/emotion/src/withStyle.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","id":"withStyle","title":"withStyle"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/themes\n * ---\n *\n * A decorator or higher order component that makes a component themeable.\n *\n * It adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n *\n * As a HOC:\n *\n * ```js-code\n * import { withStyle, jsx } from '@instructure/emotion'\n * import generateStyle from './styles'\n * import generateComponentTheme from './theme'\n *\n * export default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n * ```\n *\n * Themeable components inject their themed styles into the document\n * when they are mounted.\n *\n * ### Applying themes\n *\n * A themeable component’s theme can be configured via wrapping it in an\n * [InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\n * explicitly via its `themeOverride` prop.\n *\n * InstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\n * These variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n *\n * With the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n *\n * See more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n *\n * ```js-code\n * // ExampleComponent/theme.js\n * const generateComponentTheme = (theme) => {\n * const { colors } = theme\n *\n * const componentVariables = {\n * background: colors?.backgroundMedium,\n * color: colors?.textDarkest,\n *\n * hoverColor: colors?.textLightest,\n * hoverBackground: colors?.backgroundDarkest\n * }\n *\n * return componentVariables\n * }\n * export default generateComponentTheme\n * ```\n *\n * ```jsx-code\n * {// global theme override}\n * \n * {// component theme override}\n * \n *\n * {// component theme override with function}\n * ({\n * hoverBackground: componentTheme.background,\n * activeBackground: currentTheme.colors.backgroundBrand\n * })} />\n * \n * ```\n *\n * @module withStyle\n *\n * @param {function} generateStyle - The function that returns the component's style object\n * @param {function} generateComponentTheme - The function that returns the component's theme variables object\n * @returns {ReactElement} The decorated WithStyle Component\n */","meta":{"filename":"guxua332ivqluemc2363i.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"\nA decorator or higher order component that makes a component themeable.\n\nIt adds a `makeStyles` function and the generated `styles` object to the decorated Component's props. If it has an own theme, it also adds the `themeOverride` prop to the component.\n\nAs a HOC:\n\n```js-code\nimport { withStyle, jsx } from '@instructure/emotion'\nimport generateStyle from './styles'\nimport generateComponentTheme from './theme'\n\nexport default withStyle(generateStyle, generateComponentTheme)(ExampleComponent)\n```\n\nThemeable components inject their themed styles into the document\nwhen they are mounted.\n\n### Applying themes\n\nA themeable component’s theme can be configured via wrapping it in an\n[InstUISettingsProvider](#InstUISettingsProvider) component, and/or set\nexplicitly via its `themeOverride` prop.\n\nInstUISettingsProvider provides a theme object with global theme variables (e.g. the [canvas theme](/#canvas)).\nThese variables are mapped to the component's own variables in `theme.js` (see [@instructure/emotion](#emotion) package documentation for more info).\n\nWith the `themeOverride` prop you can directly set/override the component theme variables declared in theme.js. It accepts an object or a function. The function has the component's theme and the currently active main theme as its parameter.\n\nSee more about the overrides on the [Using theme overrides](/#using-theme-overrides) docs page.\n\n```js-code\n// ExampleComponent/theme.js\nconst generateComponentTheme = (theme) => {\n const { colors } = theme\n\n const componentVariables = {\n background: colors?.backgroundMedium,\n color: colors?.textDarkest,\n\n hoverColor: colors?.textLightest,\n hoverBackground: colors?.backgroundDarkest\n }\n\n return componentVariables\n}\nexport default generateComponentTheme\n```\n\n```jsx-code\n{// global theme override}\n\n {// component theme override}\n \n\n {// component theme override with function}\n ({\n hoverBackground: componentTheme.background,\n activeBackground: currentTheme.colors.backgroundBrand\n })} />\n\n```","kind":"module","name":"withStyle","params":[{"type":{"names":["function"]},"description":"The function that returns the component's style object","name":"generateStyle"},{"type":{"names":["function"]},"description":"The function that returns the component's theme variables object","name":"generateComponentTheme"}],"returns":[{"type":{"names":["ReactElement"]},"description":"The decorated WithStyle Component"}],"longname":"module:withStyle","undocumented":false,"category":"utilities/themes","relativePath":"packages/emotion/src/withStyle.tsx","extension":".tsx","srcPath":"packages/emotion/src/withStyle.tsx","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","packageName":"@instructure/emotion","requirePath":"@instructure/emotion/lib/withStyle","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/emotion/src/withStyle.tsx').default","esPath":"@instructure/emotion/es/withStyle","themePath":"packages/emotion/src/withStyle.tsx","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/emotion/src/withStyle.tsx","id":"withStyle","title":"withStyle"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/within.json b/pr-preview/pr-1690/docs/within.json index 96687b571c..ffd21f6a9c 100644 --- a/pr-preview/pr-1690/docs/within.json +++ b/pr-preview/pr-1690/docs/within.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Determines if one numerical value (a) is within a designated range (diff) of another (b)\n *\n * @module within\n *\n * @param {number} a\n * @param {number} b\n * @param {number} [diff=1]\n * @returns {Boolean} Returns true if a is within the diff range of b\n */","meta":{"filename":"2xg8g6vxsrz5sxdmjg7p7m.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Determines if one numerical value (a) is within a designated range (diff) of another (b)","kind":"module","name":"within","params":[{"type":{"names":["number"]},"name":"a"},{"type":{"names":["number"]},"name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"name":"diff"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true if a is within the diff range of b"}],"longname":"module:within","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/within.ts","extension":".ts","srcPath":"packages/ui-utils/src/within.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/within","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/within.ts').default","esPath":"@instructure/ui-utils/es/within","themePath":"packages/ui-utils/src/within.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","id":"within","title":"within"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities\n * ---\n * Determines if one numerical value (a) is within a designated range (diff) of another (b)\n *\n * @module within\n *\n * @param {number} a\n * @param {number} b\n * @param {number} [diff=1]\n * @returns {Boolean} Returns true if a is within the diff range of b\n */","meta":{"filename":"l6inqd8ih59tx7l72oxvpe.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Determines if one numerical value (a) is within a designated range (diff) of another (b)","kind":"module","name":"within","params":[{"type":{"names":["number"]},"name":"a"},{"type":{"names":["number"]},"name":"b"},{"type":{"names":["number"]},"optional":true,"defaultvalue":1,"name":"diff"}],"returns":[{"type":{"names":["Boolean"]},"description":"Returns true if a is within the diff range of b"}],"longname":"module:within","undocumented":false,"category":"utilities","relativePath":"packages/ui-utils/src/within.ts","extension":".ts","srcPath":"packages/ui-utils/src/within.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","packageName":"@instructure/ui-utils","requirePath":"@instructure/ui-utils/lib/within","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-utils/src/within.ts').default","esPath":"@instructure/ui-utils/es/within","themePath":"packages/ui-utils/src/within.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-utils/src/within.ts","id":"within","title":"within"} \ No newline at end of file diff --git a/pr-preview/pr-1690/docs/xor.json b/pr-preview/pr-1690/docs/xor.json index bc98fca2b1..1aeaffebd2 100644 --- a/pr-preview/pr-1690/docs/xor.json +++ b/pr-preview/pr-1690/docs/xor.json @@ -1 +1 @@ -{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that a prop cannot be given if one or more other props are also\n * given.\n *\n * ```js-code\n * import { xor } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n * significantDigits: xor(PropTypes.number, 'decimalPrecision')\n * }\n * ...\n * ```\n *\n * This will throw an error if both the `decimalPrecision` and\n * `significantDigits` props are provided.\n * @module xor\n * @param {function} propType - validates the prop type. Returns null if valid, error otherwise\n * @param {...string} otherPropNames - reject if any of these other props are also given\n * @returns {function} A function that returns Error if any of the other props\n * are also given, null otherwise\n */","meta":{"filename":"4if9rk82jivi9v2xlibt.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that a prop cannot be given if one or more other props are also\ngiven.\n\n```js-code\n import { xor } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n significantDigits: xor(PropTypes.number, 'decimalPrecision')\n }\n ...\n```\n\nThis will throw an error if both the `decimalPrecision` and\n`significantDigits` props are provided.","kind":"module","name":"xor","params":[{"type":{"names":["function"]},"description":"validates the prop type. Returns null if valid, error otherwise","name":"propType"},{"type":{"names":["string"]},"variable":true,"description":"reject if any of these other props are also given","name":"otherPropNames"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if any of the other props\nare also given, null otherwise"}],"longname":"module:xor","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/xor.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/xor.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/xor","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/xor.ts').default","esPath":"@instructure/ui-prop-types/es/xor","themePath":"packages/ui-prop-types/src/xor.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","id":"xor","title":"xor"} \ No newline at end of file +{"comment":"/**\n * ---\n * category: utilities/PropTypes\n * ---\n * Verify that a prop cannot be given if one or more other props are also\n * given.\n *\n * ```js-code\n * import { xor } from '@instructure/ui-prop-types'\n *\n * class Foo extends Component {\n * static propTypes = {\n * decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n * significantDigits: xor(PropTypes.number, 'decimalPrecision')\n * }\n * ...\n * ```\n *\n * This will throw an error if both the `decimalPrecision` and\n * `significantDigits` props are provided.\n * @module xor\n * @param {function} propType - validates the prop type. Returns null if valid, error otherwise\n * @param {...string} otherPropNames - reject if any of these other props are also given\n * @returns {function} A function that returns Error if any of the other props\n * are also given, null otherwise\n */","meta":{"filename":"37uwstu01l4ed8xg6a2zyv.js","lineno":1,"columnno":0,"path":"/tmp","code":{}},"description":"Verify that a prop cannot be given if one or more other props are also\ngiven.\n\n```js-code\n import { xor } from '@instructure/ui-prop-types'\n\n class Foo extends Component {\n static propTypes = {\n decimalPrecision: xor(PropTypes.number, 'significantDigits'),\n significantDigits: xor(PropTypes.number, 'decimalPrecision')\n }\n ...\n```\n\nThis will throw an error if both the `decimalPrecision` and\n`significantDigits` props are provided.","kind":"module","name":"xor","params":[{"type":{"names":["function"]},"description":"validates the prop type. Returns null if valid, error otherwise","name":"propType"},{"type":{"names":["string"]},"variable":true,"description":"reject if any of these other props are also given","name":"otherPropNames"}],"returns":[{"type":{"names":["function"]},"description":"A function that returns Error if any of the other props\nare also given, null otherwise"}],"longname":"module:xor","undocumented":false,"category":"utilities/PropTypes","relativePath":"packages/ui-prop-types/src/xor.ts","extension":".ts","srcPath":"packages/ui-prop-types/src/xor.ts","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","packageName":"@instructure/ui-prop-types","requirePath":"@instructure/ui-prop-types/lib/xor","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/packages/ui-prop-types/src/xor.ts').default","esPath":"@instructure/ui-prop-types/es/xor","themePath":"packages/ui-prop-types/src/xor.ts","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/packages/ui-prop-types/src/xor.ts","id":"xor","title":"xor"} \ No newline at end of file diff --git a/pr-preview/pr-1690/49e6e8799cb6ec6857af.woff b/pr-preview/pr-1690/e7b3f60c4301185b39cc.woff similarity index 99% rename from pr-preview/pr-1690/49e6e8799cb6ec6857af.woff rename to pr-preview/pr-1690/e7b3f60c4301185b39cc.woff index 8650bae3751243363ea4c64a5ea3f649402f9833..0c0c8d7e11a1a17a388151bad9c3645fed2170d3 100644 GIT binary patch delta 63 zcmV-F0Kos0+ya!`0+5XZ;u8n4kjbAZE-#bVcz&C&4BYIEKoN$=N{^di^#4!)zq5C< V_W-#Z3``(V09iZ@hO>g8k`2{`9lZbm delta 63 zcmV-F0Kos0+ya!`0+5XZ#PYGRkjbAZu9i~Hcz&C&4BYIEKoN$=BEblorem.generateWords(),paragraph:()=>lorem.generateSentences(5),paragraphs:count=>lorem.generateSentences(count||Math.floor(10*Math.random()))},mirrorHorizontalPlacement:_uiPosition.mirrorHorizontalPlacement,placeholderImage:_placeholderImage.default,React:_react.default,ReactDOM:_reactDom.default,useContext:_react.useContext,useEffect:_react.useEffect,useMemo:_react.useMemo,useState:_react.useState,useRef:_react.useRef,additionalPrimitives:_uiThemes.additionalPrimitives,dataVisualization:_uiThemes.dataVisualization,ThemeColors:_ThemeColors.default,ColorTable:_ColorTable.default} +const Components=__webpack_require__(30341),lorem=new _loremIpsum.LoremIpsum({sentencesPerParagraph:{max:8,min:4},wordsPerSentence:{max:16,min:4}}),globals={...Components,debounce:_debounce.debounce,moment:_moment.default,avatarSquare:_avatarSquare.default,avatarPortrait:_avatarPortrait.default,DateTime:_uiI18n.DateTime,iconExample:_heart_lg.default,lorem:{sentence:()=>lorem.generateWords(),paragraph:()=>lorem.generateSentences(5),paragraphs:count=>lorem.generateSentences(count||Math.floor(10*Math.random()))},mirrorHorizontalPlacement:_uiPosition.mirrorHorizontalPlacement,placeholderImage:_placeholderImage.default,React:_react.default,ReactDOM:_reactDom.default,useContext:_react.useContext,useEffect:_react.useEffect,useMemo:_react.useMemo,useState:_react.useState,useRef:_react.useRef,forwardRef:_react.forwardRef,additionalPrimitives:_uiThemes.additionalPrimitives,dataVisualization:_uiThemes.dataVisualization,ThemeColors:_ThemeColors.default,ColorTable:_ColorTable.default} Object.keys(globals).forEach((key=>{__webpack_require__.g[key]=globals[key]})) exports.default=globals},53002:(__unused_webpack_module,exports,__webpack_require__)=>{"use strict" var _interopRequireDefault=__webpack_require__(4293).default,_interopRequireWildcard=__webpack_require__(78920).default @@ -1081,13 +1081,15 @@ if("prev"===direction){if(!this.hasPrevMonth)return if(onRequestRenderPrevMonth)return void onRequestRenderPrevMonth(e,newDate.subtract({months:1}).format("YYYY-MM")) newDate.subtract({months:1})}else{if(!this.hasNextMonth)return if(onRequestRenderNextMonth)return void onRequestRenderNextMonth(e,newDate.add({months:1}).format("YYYY-MM")) -newDate.add({months:1})}this.setState({visibleMonth:newDate})},this.handleYearChange=(e,year)=>{const withYearPicker=this.props.withYearPicker,newDate=this.state.visibleMonth.clone() -null!=withYearPicker&&withYearPicker.onRequestYearChange?withYearPicker.onRequestYearChange(e,year):(newDate.year(year),this.setState({visibleMonth:newDate}))},this.handleDayClick=(event,{date})=>{if(this.props.onDateSelected){const parsedDate=DateTime.c.parse(date,this.locale(),this.timezone()) +newDate.add({months:1})}this.setState({visibleMonth:newDate})},this.handleYearChange=(e,year)=>{const withYearPicker=this.props.withYearPicker,visibleMonth=this.state.visibleMonth,yearNumber=Number(DateTime.c.parse(year,this.locale(),this.timezone()).locale("en").format("YYYY")),newDate=visibleMonth.clone() +null!=withYearPicker&&withYearPicker.onRequestYearChange?withYearPicker.onRequestYearChange(e,yearNumber):(newDate.year(yearNumber),this.setState({visibleMonth:newDate}))},this.handleDayClick=(event,{date})=>{if(this.props.onDateSelected){const parsedDate=DateTime.c.parse(date,this.locale(),this.timezone()) this.props.onDateSelected(parsedDate.toISOString(),parsedDate,event)}},this.state=this.calculateState(this.locale(),this.timezone(),props.currentDate)}componentDidMount(){var _this$props$makeStyle,_this$props3 null===(_this$props$makeStyle=(_this$props3=this.props).makeStyles)||void 0===_this$props$makeStyle||_this$props$makeStyle.call(_this$props3)}componentDidUpdate(prevProps){var _this$props$makeStyle2,_this$props4 -null===(_this$props$makeStyle2=(_this$props4=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props4);(prevProps.locale!==this.props.locale||prevProps.timezone!==this.props.timezone||prevProps.visibleMonth!==this.props.visibleMonth)&&this.setState((()=>({...this.calculateState(this.locale(),this.timezone(),this.props.currentDate)})))}get role(){return"listbox"===this.props.role?this.props.role:void 0}get hasPrevMonth(){return!this.props.withYearPicker||this.props.withYearPicker&&Number(this.state.visibleMonth.clone().subtract({months:1}).format("YYYY"))>=this.props.withYearPicker.startYear}get hasNextMonth(){return!this.props.withYearPicker||this.props.withYearPicker&&Number(this.state.visibleMonth.clone().add({months:1}).format("YYYY"))<=this.props.withYearPicker.endYear}renderHeader(){const _this$props5=this.props,renderNavigationLabel=_this$props5.renderNavigationLabel,styles=_this$props5.styles,withYearPicker=_this$props5.withYearPicker,visibleMonth=this.state.visibleMonth,_this$renderMonthNavi=this.renderMonthNavigationButtons(),prevButton=_this$renderMonthNavi.prevButton,nextButton=_this$renderMonthNavi.nextButton,cloneButton=(button,onClick)=>(0,safeCloneElement.Z)(button,{onClick:(0,createChainedFunction.v)(button.props.onClick,onClick)}),style=[null==styles?void 0:styles.navigation,...prevButton||nextButton?[null==styles?void 0:styles.navigationWithButtons]:[]],yearList=[] +null===(_this$props$makeStyle2=(_this$props4=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props4);(prevProps.locale!==this.props.locale||prevProps.timezone!==this.props.timezone||prevProps.visibleMonth!==this.props.visibleMonth)&&this.setState((()=>({...this.calculateState(this.locale(),this.timezone(),this.props.currentDate)})))}get role(){return"listbox"===this.props.role?this.props.role:void 0}get hasPrevMonth(){const yearNumber=Number(this.state.visibleMonth.clone().locale("en").subtract({months:1}).format("YYYY")) +return!this.props.withYearPicker||this.props.withYearPicker&&yearNumber>=this.props.withYearPicker.startYear}get hasNextMonth(){const yearNumber=Number(this.state.visibleMonth.clone().locale("en").add({months:1}).format("YYYY")) +return!this.props.withYearPicker||this.props.withYearPicker&&yearNumber<=this.props.withYearPicker.endYear}renderHeader(){const _this$props5=this.props,renderNavigationLabel=_this$props5.renderNavigationLabel,styles=_this$props5.styles,withYearPicker=_this$props5.withYearPicker,visibleMonth=this.state.visibleMonth,_this$renderMonthNavi=this.renderMonthNavigationButtons(),prevButton=_this$renderMonthNavi.prevButton,nextButton=_this$renderMonthNavi.nextButton,cloneButton=(button,onClick)=>(0,safeCloneElement.Z)(button,{onClick:(0,createChainedFunction.v)(button.props.onClick,onClick)}),style=[null==styles?void 0:styles.navigation,...prevButton||nextButton?[null==styles?void 0:styles.navigationWithButtons]:[]],yearList=[] if(withYearPicker){const startYear=withYearPicker.startYear -for(let year=withYearPicker.endYear;year>=startYear;year--)yearList.push(year)}return(0,emotion_react_browser_esm.Y)("div",null,(0,emotion_react_browser_esm.Y)("div",{css:style},prevButton&&cloneButton(prevButton,this.handleMonthChange("prev")),renderNavigationLabel?(0,callRenderProp.c)(renderNavigationLabel):(0,emotion_react_browser_esm.Y)("span",null,(0,emotion_react_browser_esm.Y)("div",null,visibleMonth.format("MMMM")),withYearPicker?null:(0,emotion_react_browser_esm.Y)("div",null,visibleMonth.format("YYYY"))),nextButton&&cloneButton(nextButton,this.handleMonthChange("next"))),withYearPicker?(0,emotion_react_browser_esm.Y)("div",{css:null==styles?void 0:styles.yearPicker},(0,emotion_react_browser_esm.Y)(SimpleSelect.X,{width:"90px",renderLabel:"",assistiveText:withYearPicker.screenReaderLabel,value:Number(visibleMonth.format("YYYY")),onChange:(e,{value})=>this.handleYearChange(e,Number(value))},yearList.map((year=>(0,emotion_react_browser_esm.Y)(SimpleSelect.X.Option,{key:year,id:`opt-${year}`,value:year},`${year}`))))):null)}renderBody(){return(0,emotion_react_browser_esm.Y)("table",{role:this.role},(0,emotion_react_browser_esm.Y)("thead",null,this.renderWeekdayHeaders()),(0,emotion_react_browser_esm.Y)("tbody",null,this.renderDays()))}renderWeekdayHeaders(){const styles=this.props.styles,renderWeekdayLabels=this.props.renderWeekdayLabels||this.defaultWeekdays,length=renderWeekdayLabels.length +for(let year=withYearPicker.endYear;year>=startYear;year--)yearList.push(DateTime.c.parse(year.toString(),this.locale(),this.timezone()).format("YYYY"))}return(0,emotion_react_browser_esm.Y)("div",null,(0,emotion_react_browser_esm.Y)("div",{css:style},prevButton&&cloneButton(prevButton,this.handleMonthChange("prev")),renderNavigationLabel?(0,callRenderProp.c)(renderNavigationLabel):(0,emotion_react_browser_esm.Y)("span",null,(0,emotion_react_browser_esm.Y)("div",null,visibleMonth.format("MMMM")),withYearPicker?null:(0,emotion_react_browser_esm.Y)("div",null,visibleMonth.format("YYYY"))),nextButton&&cloneButton(nextButton,this.handleMonthChange("next"))),withYearPicker?(0,emotion_react_browser_esm.Y)("div",{css:null==styles?void 0:styles.yearPicker},(0,emotion_react_browser_esm.Y)(SimpleSelect.X,{width:"90px",renderLabel:"",placeholder:"--",assistiveText:withYearPicker.screenReaderLabel,value:visibleMonth.format("YYYY"),onChange:(e,{value})=>this.handleYearChange(e,`${value}`)},yearList.map((year=>(0,emotion_react_browser_esm.Y)(SimpleSelect.X.Option,{key:year,id:`opt-${year}`,value:year},`${year}`))))):null)}renderBody(){return(0,emotion_react_browser_esm.Y)("table",{role:this.role},(0,emotion_react_browser_esm.Y)("thead",null,this.renderWeekdayHeaders()),(0,emotion_react_browser_esm.Y)("tbody",null,this.renderDays()))}renderWeekdayHeaders(){const styles=this.props.styles,renderWeekdayLabels=this.props.renderWeekdayLabels||this.defaultWeekdays,length=renderWeekdayLabels.length return(0,es.logError)(7===length,`[Calendar] \`renderWeekdayLabels\` should be an array with 7 labels (one for each weekday). ${length} provided.`),(0,emotion_react_browser_esm.Y)("tr",null,renderWeekdayLabels.map(((label,i)=>(0,emotion_react_browser_esm.Y)("th",{key:i,scope:"col",css:null==styles?void 0:styles.weekdayHeader,id:this._weekdayHeaderIds[i]},(0,callRenderProp.c)(label)))))}get defaultWeekdays(){const shortDayNames=DateTime.c.getLocalDayNamesOfTheWeek(this.locale(),"short"),longDayNames=DateTime.c.getLocalDayNamesOfTheWeek(this.locale(),"long") return[(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:1,alt:longDayNames[0]},shortDayNames[0]),(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:2,alt:longDayNames[1]},shortDayNames[1]),(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:3,alt:longDayNames[2]},shortDayNames[2]),(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:4,alt:longDayNames[3]},shortDayNames[3]),(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:5,alt:longDayNames[4]},shortDayNames[4]),(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:6,alt:longDayNames[5]},shortDayNames[5]),(0,emotion_react_browser_esm.Y)(AccessibleContent._,{key:7,alt:longDayNames[6]},shortDayNames[6])]}renderDays(){const children=this.props.children,childrenArr=react.Children.toArray(children||this.renderDefaultdays()),length=childrenArr.length,role="listbox"===this.role?"presentation":void 0 return(0,es.logError)(length===Calendar.DAY_COUNT,`[Calendar] should have exactly ${Calendar.DAY_COUNT} children. ${length} provided.`),childrenArr.reduce(((days,day,i)=>{const index=Math.floor(i/7) @@ -1354,15 +1356,25 @@ return(0,emotion_react_browser_esm.Y)(TextInput.k,Object.assign({},triggerProps, this.props.children||"Enter"===e.key&&this.handleHideCalendar(e),null===(_triggerProps$onKeyDo=triggerProps.onKeyDown)||void 0===_triggerProps$onKeyDo||_triggerProps$onKeyDo.call(triggerProps,e)}}))}render(){const _this$props13=this.props,placement=_this$props13.placement,assistiveText=_this$props13.assistiveText,styles=_this$props13.styles,isShowingCalendar=this.shouldShowCalendar() return(0,emotion_react_browser_esm.Y)(Selectable.n,{isShowingOptions:isShowingCalendar,onRequestShowOptions:this.handleShowCalendar,onRequestHideOptions:this.handleHideCalendar,onRequestHighlightOption:this.handleHighlightOption,onRequestSelectOption:e=>this.handleHideCalendar(e),selectedOptionId:this.selectedDateId,highlightedOptionId:this.selectedDateId},(({getRootProps,getInputProps,getTriggerProps,getListProps,getOptionProps,getDescriptionProps})=>(0,emotion_react_browser_esm.Y)("span",Object.assign({},getRootProps({css:null==styles?void 0:styles.dateInput}),{ref:el=>this.ref=el}),this.renderInput({getInputProps,getTriggerProps}),(0,emotion_react_browser_esm.Y)("span",Object.assign({},getDescriptionProps(),{css:null==styles?void 0:styles.assistiveText}),assistiveText),(0,emotion_react_browser_esm.Y)(Popover.A,{placement,isShowingContent:isShowingCalendar,positionTarget:this._input,shouldReturnFocus:!1,shouldFocusContentOnTriggerBlur:!0},this.renderCalendar({getListProps,getOptionProps})))))}},_DateInput.displayName="DateInput",_DateInput.componentId="DateInput",_DateInput.Day=Calendar.V.Day,_DateInput.propTypes=propTypes,_DateInput.allowedProps=["renderLabel","value","size","placeholder","onChange","onBlur","interaction","isRequired","isInline","assistiveText","layout","width","display","inputRef","messages","placement","isShowingCalendar","onRequestValidateDate","onRequestShowCalendar","onRequestHideCalendar","onRequestSelectNextDay","onRequestSelectPrevDay","onRequestRenderNextMonth","onRequestRenderPrevMonth","renderNavigationLabel","renderWeekdayLabels","renderNextMonthButton","renderPrevMonthButton","children","disabledDates","currentDate","disabledDateErrorMessage","invalidDateErrorMessage","locale","timezone"],_DateInput.defaultProps={value:"",size:"medium",onBlur:()=>{},isRequired:!1,isInline:!1,layout:"stacked",display:"inline-block",placement:"bottom center",isShowingCalendar:!1},_class=_DateInput))||_class)||_class},75736:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" __webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{DateInput:()=>DateInput.J,DateInput2:()=>DateInput2}) -var DateInput=__webpack_require__(59545),slicedToArray=__webpack_require__(17338),react=__webpack_require__(14041),moment_timezone=__webpack_require__(36302),moment_timezone_default=__webpack_require__.n(moment_timezone),Calendar=__webpack_require__(64912),IconButton=__webpack_require__(30704),IconCalendarMonthLine=__webpack_require__(25469),IconArrowOpenEndSolid=__webpack_require__(83614),IconArrowOpenStartSolid=__webpack_require__(79733),Popover=__webpack_require__(38848),TextInput=__webpack_require__(7395),passthroughProps=__webpack_require__(38419),ApplyLocaleContext=__webpack_require__(44120),Locale=__webpack_require__(71524),emotion_react_browser_esm=__webpack_require__(15428),prop_types=__webpack_require__(39067),prop_types_default=__webpack_require__.n(prop_types),controllable=__webpack_require__(81720),es=__webpack_require__(12417) -const propTypes={renderLabel:prop_types_default().oneOfType([prop_types_default().node,prop_types_default().func]).isRequired,screenReaderLabels:prop_types_default().object.isRequired,value:(0,controllable._)(prop_types_default().string),size:prop_types_default().oneOf(["small","medium","large"]),placeholder:prop_types_default().string,onChange:prop_types_default().func,onBlur:prop_types_default().func,interaction:prop_types_default().oneOf(["enabled","disabled","readonly"]),isRequired:prop_types_default().bool,isInline:prop_types_default().bool,width:prop_types_default().string,messages:prop_types_default().arrayOf(es.FormPropTypes.message),onRequestShowCalendar:prop_types_default().func,onRequestHideCalendar:prop_types_default().func,onRequestValidateDate:prop_types_default().func,invalidDateErrorMessage:prop_types_default().oneOfType([prop_types_default().func,prop_types_default().string]),locale:prop_types_default().string,timezone:prop_types_default().string,withYearPicker:prop_types_default().object} +var DateInput=__webpack_require__(59545),slicedToArray=__webpack_require__(17338),react=__webpack_require__(14041),Calendar=__webpack_require__(64912),IconButton=__webpack_require__(30704),IconCalendarMonthLine=__webpack_require__(25469),IconArrowOpenEndSolid=__webpack_require__(83614),IconArrowOpenStartSolid=__webpack_require__(79733),Popover=__webpack_require__(38848),TextInput=__webpack_require__(7395),passthroughProps=__webpack_require__(38419),ApplyLocaleContext=__webpack_require__(44120),Locale=__webpack_require__(71524),emotion_react_browser_esm=__webpack_require__(15428),prop_types=__webpack_require__(39067),prop_types_default=__webpack_require__.n(prop_types),controllable=__webpack_require__(81720),es=__webpack_require__(12417) +const propTypes={renderLabel:prop_types_default().oneOfType([prop_types_default().node,prop_types_default().func]).isRequired,screenReaderLabels:prop_types_default().object.isRequired,value:(0,controllable._)(prop_types_default().string),placeholder:prop_types_default().string,onChange:prop_types_default().func,onBlur:prop_types_default().func,interaction:prop_types_default().oneOf(["enabled","disabled","readonly"]),isRequired:prop_types_default().bool,isInline:prop_types_default().bool,width:prop_types_default().string,messages:prop_types_default().arrayOf(es.FormPropTypes.message),invalidDateErrorMessage:prop_types_default().oneOfType([prop_types_default().func,prop_types_default().string]),locale:prop_types_default().string,timezone:prop_types_default().string,withYearPicker:prop_types_default().object,dateFormat:prop_types_default().oneOfType([prop_types_default().string,prop_types_default().object]),onRequestValidateDate:prop_types_default().func} var _IconCalendarMonthLin,_IconArrowOpenEndSoli,_IconArrowOpenStartSo -const DateInput2=({renderLabel,screenReaderLabels,isRequired=!1,interaction="enabled",size="medium",isInline=!1,value,messages,width,onChange,onBlur,withYearPicker,onRequestValidateDate,invalidDateErrorMessage,locale,timezone,placeholder,...rest})=>{const _useState=(0,react.useState)(""),_useState2=(0,slicedToArray.A)(_useState,2),selectedDate=_useState2[0],setSelectedDate=_useState2[1],_useState3=(0,react.useState)(messages||[]),_useState4=(0,slicedToArray.A)(_useState3,2),inputMessages=_useState4[0],setInputMessages=_useState4[1],_useState5=(0,react.useState)(!1),_useState6=(0,slicedToArray.A)(_useState5,2),showPopover=_useState6[0],setShowPopover=_useState6[1],localeContext=(0,react.useContext)(ApplyLocaleContext.A);(0,react.useEffect)((()=>{validateInput(!0)}),[value]),(0,react.useEffect)((()=>{setInputMessages(messages||[])}),[messages]) -const handleInputChange=(e,value)=>{null==onChange||onChange(e,value)},validateInput=(onlyRemoveError=!1)=>!isNaN(new Date(value||"").getTime())&&function(dateString,locale,timezone){return moment_timezone_default().tz(dateString,[moment_timezone_default().ISO_8601,"llll","LLLL","lll","LLL","ll","LL","l","L"],locale,!0,timezone).isValid()}(value||"",getLocale(),getTimezone())||""===value?(setSelectedDate(value||""),setInputMessages(messages||[]),!0):(onlyRemoveError||"string"!=typeof invalidDateErrorMessage||setInputMessages((messages=>[{type:"error",text:invalidDateErrorMessage},...messages])),!1),getLocale=()=>locale||(localeContext.locale?localeContext.locale:Locale.h.browserLocale()),getTimezone=()=>timezone||(localeContext.timezone?localeContext.timezone:Intl.DateTimeFormat().resolvedOptions().timeZone) -return(0,emotion_react_browser_esm.Y)(TextInput.k,Object.assign({},(0,passthroughProps.V)(rest),{renderLabel,onChange:handleInputChange,onBlur:e=>{const isInputValid=validateInput(!1) -if(isInputValid&&value){const formattedDate=new Date(value).toLocaleDateString(getLocale(),{month:"long",year:"numeric",day:"numeric",timeZone:getTimezone()}) -handleInputChange(e,formattedDate)}null==onRequestValidateDate||onRequestValidateDate(value,isInputValid),null==onBlur||onBlur(e)},isRequired,value,placeholder,width,size,display:isInline?"inline-block":"block",messages:inputMessages,interaction,renderAfterInput:(0,emotion_react_browser_esm.Y)(Popover.A,{renderTrigger:(0,emotion_react_browser_esm.Y)(IconButton.K,{withBackground:!1,withBorder:!1,screenReaderLabel:screenReaderLabels.calendarIcon,shape:"circle",size,interaction},_IconCalendarMonthLin||(_IconCalendarMonthLin=(0,emotion_react_browser_esm.Y)(IconCalendarMonthLine.s,null))),isShowingContent:showPopover,onShowContent:()=>setShowPopover(!0),onHideContent:()=>setShowPopover(!1),on:"click",shouldContainFocus:!0,shouldReturnFocus:!0,shouldCloseOnDocumentClick:!0},(0,emotion_react_browser_esm.Y)(Calendar.V,{withYearPicker,onDateSelected:(dateString,_momentDate,e)=>{const formattedDate=new Date(dateString).toLocaleDateString(getLocale(),{month:"long",year:"numeric",day:"numeric",timeZone:getTimezone()}) -handleInputChange(e,formattedDate),setShowPopover(!1),null==onRequestValidateDate||onRequestValidateDate(formattedDate,!0)},selectedDate,visibleMonth:selectedDate,locale,timezone,role:"listbox",renderNextMonthButton:(0,emotion_react_browser_esm.Y)(IconButton.K,{size:"small",withBackground:!1,withBorder:!1,renderIcon:_IconArrowOpenEndSoli||(_IconArrowOpenEndSoli=(0,emotion_react_browser_esm.Y)(IconArrowOpenEndSolid.J,{color:"primary"})),screenReaderLabel:screenReaderLabels.nextMonthButton}),renderPrevMonthButton:(0,emotion_react_browser_esm.Y)(IconButton.K,{size:"small",withBackground:!1,withBorder:!1,renderIcon:_IconArrowOpenStartSo||(_IconArrowOpenStartSo=(0,emotion_react_browser_esm.Y)(IconArrowOpenStartSolid.w,{color:"primary"})),screenReaderLabel:screenReaderLabels.prevMonthButton})}))}))} +function parseLocaleDate(dateString="",locale,timeZone){const splitDate=dateString.split(/[,.\s/.-]+/).filter(Boolean),localeDate=new Intl.DateTimeFormat(locale).formatToParts(new Date) +let day,month,year,index=0 +if(localeDate.forEach((part=>{"month"===part.type?(month=parseInt(splitDate[index],10),index++):"day"===part.type?(day=parseInt(splitDate[index],10),index++):"year"===part.type&&(year=parseInt(splitDate[index],10),index++)})),!year||!month||!day||year<1e3||year>9999)return null +const date=new Date(Date.UTC(year,month-1,day)) +if(date.getMonth()!==month-1||date.getDate()!==day)return null +const dateStringInTimezone=new Intl.DateTimeFormat("en-US",{timeZone,year:"numeric",month:"2-digit",day:"2-digit",hour:"2-digit",minute:"2-digit",second:"2-digit",hour12:!1}).formatToParts(date).reduce(((acc,part)=>"literal"===part.type?acc:{...acc,[part.type]:part.value}),{}),dateInTimezone=`${dateStringInTimezone.year}-${dateStringInTimezone.month}-${dateStringInTimezone.day}T${dateStringInTimezone.hour}:${dateStringInTimezone.minute}:${dateStringInTimezone.second}`,timeDiff=new Date(dateInTimezone+"Z").getTime()-date.getTime() +return new Date(date.getTime()-timeDiff)}const DateInput2=({renderLabel,screenReaderLabels,isRequired=!1,interaction="enabled",isInline=!1,value,messages,width,onChange,onBlur,withYearPicker,invalidDateErrorMessage,locale,timezone,placeholder,dateFormat,onRequestValidateDate,...rest})=>{const localeContext=(0,react.useContext)(ApplyLocaleContext.A),getLocale=()=>locale||(localeContext.locale?localeContext.locale:Locale.h.browserLocale()),getTimezone=()=>timezone||(localeContext.timezone?localeContext.timezone:Intl.DateTimeFormat().resolvedOptions().timeZone),_useState=(0,react.useState)(messages||[]),_useState2=(0,slicedToArray.A)(_useState,2),inputMessages=_useState2[0],setInputMessages=_useState2[1],_useState3=(0,react.useState)(!1),_useState4=(0,slicedToArray.A)(_useState3,2),showPopover=_useState4[0],setShowPopover=_useState4[1];(0,react.useEffect)((()=>{inputMessages||setInputMessages(messages||[])}),[messages]),(0,react.useEffect)((()=>{const _parseDate=parseDate(value) +!(0,slicedToArray.A)(_parseDate,2)[1]&&value||setInputMessages(messages||[])}),[value]) +const parseDate=(dateString="")=>{let date=null +return dateFormat?"string"==typeof dateFormat?date=parseLocaleDate(dateString,dateFormat,getTimezone()):dateFormat.parser&&(date=dateFormat.parser(dateString)):date=parseLocaleDate(dateString,getLocale(),getTimezone()),date?[formatDate(date),date.toISOString()]:["",""]},formatDate=date=>"string"!=typeof dateFormat&&null!=dateFormat&&dateFormat.formatter?dateFormat.formatter(date):date.toLocaleDateString("string"==typeof dateFormat?dateFormat:getLocale(),{timeZone:getTimezone(),calendar:"gregory",numberingSystem:"latn"}),selectedDate=parseDate(value)[1] +return(0,emotion_react_browser_esm.Y)(TextInput.k,Object.assign({},(0,passthroughProps.V)(rest),{renderLabel,onChange:(e,newValue)=>{const _parseDate3=parseDate(newValue),utcIsoDate=(0,slicedToArray.A)(_parseDate3,2)[1] +null==onChange||onChange(e,newValue,utcIsoDate)},onBlur:e=>{const _parseDate5=parseDate(value),_parseDate6=(0,slicedToArray.A)(_parseDate5,2),localeDate=_parseDate6[0],utcIsoDate=_parseDate6[1] +localeDate?localeDate!==value&&(null==onChange||onChange(e,localeDate,utcIsoDate)):value&&invalidDateErrorMessage&&setInputMessages([{type:"error",text:invalidDateErrorMessage}]),null==onRequestValidateDate||onRequestValidateDate(e,value||"",utcIsoDate),null==onBlur||onBlur(e,value||"",utcIsoDate)},isRequired,value,placeholder:null!=placeholder?placeholder:(()=>{const exampleDate=new Date("2024-09-01"),formattedDate=formatDate(exampleDate),regex=n=>new RegExp(`(?"Y".repeat(match.length))).replace(regex(month),(match=>"M".repeat(match.length))).replace(regex(day),(match=>"D".repeat(match.length)))})(),width,display:isInline?"inline-block":"block",messages:inputMessages,interaction,renderAfterInput:(0,emotion_react_browser_esm.Y)(Popover.A,{renderTrigger:(0,emotion_react_browser_esm.Y)(IconButton.K,{withBackground:!1,withBorder:!1,screenReaderLabel:screenReaderLabels.calendarIcon,shape:"circle",interaction},_IconCalendarMonthLin||(_IconCalendarMonthLin=(0,emotion_react_browser_esm.Y)(IconCalendarMonthLine.s,null))),isShowingContent:showPopover,onShowContent:()=>setShowPopover(!0),onHideContent:()=>setShowPopover(!1),on:"click",shouldContainFocus:!0,shouldReturnFocus:!0,shouldCloseOnDocumentClick:!0},(0,emotion_react_browser_esm.Y)(Calendar.V,{withYearPicker,onDateSelected:(dateString,_momentDate,e)=>{setShowPopover(!1) +const newValue=formatDate(new Date(dateString)) +null==onChange||onChange(e,newValue,dateString),null==onRequestValidateDate||onRequestValidateDate(e,newValue,dateString)},selectedDate,visibleMonth:selectedDate,locale:getLocale(),timezone:getTimezone(),role:"listbox",renderNextMonthButton:(0,emotion_react_browser_esm.Y)(IconButton.K,{size:"small",withBackground:!1,withBorder:!1,renderIcon:_IconArrowOpenEndSoli||(_IconArrowOpenEndSoli=(0,emotion_react_browser_esm.Y)(IconArrowOpenEndSolid.J,{color:"primary"})),screenReaderLabel:screenReaderLabels.nextMonthButton}),renderPrevMonthButton:(0,emotion_react_browser_esm.Y)(IconButton.K,{size:"small",withBackground:!1,withBorder:!1,renderIcon:_IconArrowOpenStartSo||(_IconArrowOpenStartSo=(0,emotion_react_browser_esm.Y)(IconArrowOpenStartSolid.w,{color:"primary"})),screenReaderLabel:screenReaderLabels.prevMonthButton})}))}))} DateInput2.propTypes=propTypes},77586:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" __webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{DateTimeInput:()=>DateTimeInput}) var react=__webpack_require__(14041),DateTime=__webpack_require__(59503),Locale=__webpack_require__(71524),ApplyLocaleContext=__webpack_require__(44120),es=__webpack_require__(12417),DateInput=__webpack_require__(59545),TimeSelect=__webpack_require__(51543),Calendar=__webpack_require__(64912),testable=__webpack_require__(95982),AccessibleContent=__webpack_require__(21813),IconButton=__webpack_require__(30704),IconArrowOpenStartSolid=__webpack_require__(79733),IconArrowOpenEndSolid=__webpack_require__(83614),I18nPropTypes=__webpack_require__(97854),prop_types=__webpack_require__(39067),prop_types_default=__webpack_require__.n(prop_types),controllable=__webpack_require__(81720) @@ -4734,7 +4746,7 @@ var NumberInput=__webpack_require__(79915),ScreenReaderContent=__webpack_require const styles=componentTheme=>({paginationPageInput:{label:"paginationPageInput",display:"inline-flex",alignItems:"center",margin:`0 ${componentTheme.inputSpacing}`},numberInput:{label:"paginationPageInput__input",width:componentTheme.inputWidth},inputLabel:{label:"paginationPageInput__inputLabel",marginInlineStart:componentTheme.inputSpacing,whiteSpace:"nowrap"}}),theme=theme=>({...{inputSpacing:theme.spacing.xSmall,inputWidth:"4.5rem"}}),PaginationPageInput_props_propTypes={numberOfPages:prop_types_default().number.isRequired,currentPageIndex:prop_types_default().number.isRequired,onChange:prop_types_default().func.isRequired,screenReaderLabel:prop_types_default().func.isRequired,label:prop_types_default().func,disabled:prop_types_default().bool,inputRef:prop_types_default().func} var PaginationPageInput_class,_PaginationPageInput let PaginationPageInput=(0,withStyle._)(styles,theme)(PaginationPageInput_class=(0,testable.$)()((_PaginationPageInput=class extends react.Component{constructor(props){super(props),this.ref=null,this.handleRef=el=>{this.ref=el},this.handleInputRef=el=>{"function"==typeof this.props.inputRef&&this.props.inputRef(el)},this.handleChange=(_event,value)=>{let newValue=value -value.length>0&&isNaN(value.slice(-1))&&(newValue=value.slice(0,-1)),this.setState({number:newValue?Number(newValue):this.MIN,value:newValue})},this.handleDecrement=event=>{this.setNewPage(event,Math.floor(this.currentPage-1))},this.handleIncrement=event=>{this.setNewPage(event,Math.floor(this.currentPage+1))},this.handleBlur=event=>{this.setNewPage(event,Math.round(this.state.number))},this.state=this.initialState}get currentPage(){return this.props.currentPageIndex+1}get initialState(){return{number:this.currentPage,value:`${this.currentPage}`}}get MIN(){return 1}get MAX(){return this.props.numberOfPages}componentDidMount(){var _this$props$makeStyle,_this$props +value.length>0&&isNaN(value.slice(-1))&&(newValue=value.slice(0,-1)),this.setState({number:newValue?Number(newValue):this.MIN,value:newValue})},this.handleDecrement=event=>{this.setNewPage(event,Math.floor(this.currentPage-1))},this.handleIncrement=event=>{this.setNewPage(event,Math.floor(this.currentPage+1))},this.handleBlur=event=>{Math.round(this.state.number)!==this.currentPage&&this.setNewPage(event,Math.round(this.state.number))},this.state=this.initialState}get currentPage(){return this.props.currentPageIndex+1}get initialState(){return{number:this.currentPage,value:`${this.currentPage}`}}get MIN(){return 1}get MAX(){return this.props.numberOfPages}componentDidMount(){var _this$props$makeStyle,_this$props null===(_this$props$makeStyle=(_this$props=this.props).makeStyles)||void 0===_this$props$makeStyle||_this$props$makeStyle.call(_this$props)}componentDidUpdate(prevProps){var _this$props$makeStyle2,_this$props2 null===(_this$props$makeStyle2=(_this$props2=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props2),this.props.currentPageIndex!==prevProps.currentPageIndex&&this.resetInitialState()}resetInitialState(){this.setState(this.initialState)}handleKeyDown(event){if("enter"===event.key.toLowerCase()){const _this$state=this.state,value=_this$state.value,number=_this$state.number if(""===value||isNaN(value))return void this.resetInitialState() @@ -4931,8 +4943,8 @@ var _class,_ProgressBar let ProgressBar=(0,withStyle._)(styles,theme)(_class=(0,testable.$)()((_ProgressBar=class extends react.Component{constructor(...args){super(...args),this.ref=null,this.handleRef=el=>{const elementRef=this.props.elementRef this.ref=el,"function"==typeof elementRef&&elementRef(el)}}componentDidMount(){var _this$props$makeStyle,_this$props null===(_this$props$makeStyle=(_this$props=this.props).makeStyles)||void 0===_this$props$makeStyle||_this$props$makeStyle.call(_this$props)}componentDidUpdate(){var _this$props$makeStyle2,_this$props2 -null===(_this$props$makeStyle2=(_this$props2=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props2)}render(){const _this$props3=this.props,renderValue=_this$props3.renderValue,formatScreenReaderValue=_this$props3.formatScreenReaderValue,valueNow=_this$props3.valueNow,valueMax=_this$props3.valueMax,screenReaderLabel=_this$props3.screenReaderLabel,styles=(_this$props3.size,_this$props3.color,_this$props3.meterColor,_this$props3.styles),props=(0,objectWithoutProperties.A)(_this$props3,_excluded),valueText="function"==typeof formatScreenReaderValue?formatScreenReaderValue({valueNow,valueMax}):void 0,labelAndValueText=`${screenReaderLabel} ${valueText}`,value=(0,callRenderProp.c)(renderValue,{valueNow,valueMax}) -return(0,emotion_react_browser_esm.Y)(View.S,Object.assign({},(0,passthroughProps.V)(props),{as:this.props.as,css:null==styles?void 0:styles.progressBar,margin:this.props.margin,elementRef:this.handleRef}),(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.trackLayout},(0,emotion_react_browser_esm.Y)("progress",{css:null==styles?void 0:styles.htmlProgress,max:valueMax,value:valueNow,role:"progressbar","aria-valuetext":valueText,"aria-valuenow":valueNow,"aria-valuemax":valueMax,"aria-label":labelAndValueText}),(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.track,role:"presentation","aria-hidden":"true"},(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.trackValue}))),value&&(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.value,"aria-hidden":"true"},value))}},_ProgressBar.displayName="ProgressBar",_ProgressBar.componentId="ProgressBar",_ProgressBar.allowedProps=["screenReaderLabel","size","valueMax","valueNow","formatScreenReaderValue","renderValue","color","meterColor","shouldAnimate","margin","elementRef","as"],_ProgressBar.propTypes=propTypes,_ProgressBar.defaultProps={formatScreenReaderValue:({valueNow,valueMax})=>`${valueNow} / ${valueMax}`,size:"medium",valueMax:100,valueNow:0,as:"div",color:"primary",shouldAnimate:!1,meterColor:({valueNow,valueMax})=>valueNow/valueMax>=1?"success":"brand"},_class=_ProgressBar))||_class)||_class +null===(_this$props$makeStyle2=(_this$props2=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props2)}render(){const _this$props3=this.props,renderValue=_this$props3.renderValue,formatScreenReaderValue=_this$props3.formatScreenReaderValue,valueNow=_this$props3.valueNow,valueMax=_this$props3.valueMax,screenReaderLabel=_this$props3.screenReaderLabel,styles=(_this$props3.size,_this$props3.color,_this$props3.meterColor,_this$props3.styles),props=(0,objectWithoutProperties.A)(_this$props3,_excluded),labelAndValueText=`${screenReaderLabel} ${"function"==typeof formatScreenReaderValue?formatScreenReaderValue({valueNow,valueMax}):void 0}`,value=(0,callRenderProp.c)(renderValue,{valueNow,valueMax}) +return(0,emotion_react_browser_esm.Y)(View.S,Object.assign({},(0,passthroughProps.V)(props),{as:this.props.as,css:null==styles?void 0:styles.progressBar,margin:this.props.margin,elementRef:this.handleRef}),(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.trackLayout},(0,emotion_react_browser_esm.Y)("progress",{css:null==styles?void 0:styles.htmlProgress,max:valueMax,value:valueNow,"aria-valuetext":labelAndValueText}),(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.track,role:"presentation","aria-hidden":"true"},(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.trackValue}))),value&&(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.value,"aria-hidden":"true"},value))}},_ProgressBar.displayName="ProgressBar",_ProgressBar.componentId="ProgressBar",_ProgressBar.allowedProps=["screenReaderLabel","size","valueMax","valueNow","formatScreenReaderValue","renderValue","color","meterColor","shouldAnimate","margin","elementRef","as"],_ProgressBar.propTypes=propTypes,_ProgressBar.defaultProps={formatScreenReaderValue:({valueNow,valueMax})=>`${valueNow} / ${valueMax}`,size:"medium",valueMax:100,valueNow:0,as:"div",color:"primary",shouldAnimate:!1,meterColor:({valueNow,valueMax})=>valueNow/valueMax>=1?"success":"brand"},_class=_ProgressBar))||_class)||_class var ScreenReaderContent=__webpack_require__(77856) const ProgressCircle_styles=(componentTheme,props,state)=>{const size=props.size,color=props.color,meterColor=props.meterColor,_props$valueNow=props.valueNow,valueNow=void 0===_props$valueNow?0:_props$valueNow,_props$valueMax=props.valueMax,valueMax=void 0===_props$valueMax?100:_props$valueMax,shouldAnimateOnMount=state.shouldAnimateOnMount,getMeterColorClassName="function"==typeof meterColor?meterColor({valueNow,valueMax}):meterColor,sizeVariants={"x-small":{progressCircle:{width:componentTheme.xSmallSize,height:componentTheme.xSmallSize},circle:{width:componentTheme.xSmallSize,height:componentTheme.xSmallSize},value:{padding:"0.5rem"},border:{transformOrigin:`${componentTheme.xSmallTransform} ${componentTheme.xSmallTransform}`},track:{transformOrigin:`${componentTheme.xSmallTransform} ${componentTheme.xSmallTransform}`,strokeWidth:componentTheme.xSmallStrokeWidth},meter:{strokeWidth:componentTheme.xSmallStrokeWidth,strokeDasharray:componentTheme.xSmallCircumference,...shouldAnimateOnMount&&{strokeDashoffset:`${componentTheme.xSmallCircumference} !important`}}},small:{progressCircle:{width:componentTheme.smallSize,height:componentTheme.smallSize},circle:{width:componentTheme.smallSize,height:componentTheme.smallSize},value:{},border:{transformOrigin:`${componentTheme.smallTransform} ${componentTheme.smallTransform}`},track:{transformOrigin:`${componentTheme.smallTransform} ${componentTheme.smallTransform}`,strokeWidth:componentTheme.smallStrokeWidth},meter:{strokeWidth:componentTheme.smallStrokeWidth,strokeDasharray:componentTheme.smallCircumference,...shouldAnimateOnMount&&{strokeDashoffset:`${componentTheme.smallCircumference} !important`}}},medium:{progressCircle:{width:componentTheme.mediumSize,height:componentTheme.mediumSize},circle:{width:componentTheme.mediumSize,height:componentTheme.mediumSize},value:{},border:{transformOrigin:`${componentTheme.mediumTransform} ${componentTheme.mediumTransform}`},track:{transformOrigin:`${componentTheme.mediumTransform} ${componentTheme.mediumTransform}`,strokeWidth:componentTheme.mediumStrokeWidth},meter:{strokeWidth:componentTheme.mediumStrokeWidth,strokeDasharray:componentTheme.mediumCircumference,...shouldAnimateOnMount&&{strokeDashoffset:`${componentTheme.mediumCircumference} !important`}}},large:{progressCircle:{width:componentTheme.largeSize,height:componentTheme.largeSize},circle:{width:componentTheme.largeSize,height:componentTheme.largeSize},value:{},border:{transformOrigin:`${componentTheme.largeTransform} ${componentTheme.largeTransform}`},track:{transformOrigin:`${componentTheme.largeTransform} ${componentTheme.largeTransform}`,strokeWidth:componentTheme.largeStrokeWidth},meter:{strokeWidth:componentTheme.largeStrokeWidth,strokeDasharray:componentTheme.largeCircumference,...shouldAnimateOnMount&&{strokeDashoffset:`${componentTheme.largeCircumference} !important`}}}},colorVariants={primary:{track:{stroke:componentTheme.trackColor},value:{color:componentTheme.color},border:{stroke:componentTheme.trackBorderColor}},"primary-inverse":{track:{stroke:componentTheme.trackColorInverse},value:{color:componentTheme.colorInverse},border:{stroke:componentTheme.trackBorderColorInverse}}},meterColorVariants={primary:{brand:{stroke:componentTheme.meterColorBrand},info:{stroke:componentTheme.meterColorInfo},warning:{stroke:componentTheme.meterColorWarning},danger:{stroke:componentTheme.meterColorDanger},alert:{stroke:componentTheme.meterColorAlert},success:{stroke:componentTheme.meterColorSuccess}},"primary-inverse":{brand:{stroke:componentTheme.meterColorBrandInverse},info:{stroke:componentTheme.meterColorInfoInverse},warning:{stroke:componentTheme.meterColorWarningInverse},danger:{stroke:componentTheme.meterColorDangerInverse},alert:{stroke:componentTheme.meterColorAlertInverse},success:{stroke:componentTheme.meterColorSuccessInverse}}} return{progressCircle:{label:"progressCircle",display:"inline-block",verticalAlign:"middle",position:"relative",overflow:"hidden",fontSize:"1rem",fontFamily:componentTheme.fontFamily,fontWeight:componentTheme.fontWeight,lineHeight:componentTheme.lineHeight,...sizeVariants[size].progressCircle},center:{label:"progressCircle__center",transition:"all 0.5s",transitionDelay:"1s",display:"block",position:"absolute",transform:"translate3d(0, 0, 0)",top:0,left:0,height:"100%",width:"100%",borderRadius:"50%",...shouldAnimateOnMount&&{opacity:0,transform:"translate3d(0, 10%, 0)"}},value:{label:"progressCircle__value",boxSizing:"border-box",wordWrap:"break-word",textAlign:"center",borderRadius:"50%",display:"flex",alignItems:"center",justifyContent:"center",padding:"1.5rem",width:"100%",height:"100%",lineHeight:1,...sizeVariants[size].value,...colorVariants[color].value},circle:{label:"progressCircle__circle",transform:"rotate(-90deg)",display:"block",position:"absolute",top:0,left:0,...sizeVariants[size].circle},track:{label:"progressCircle__track",fill:"none",opacity:1,transition:"all 0.5s",transitionDelay:"0.2s",transform:"translate3d(0, 0, 0)",...sizeVariants[size].track,...colorVariants[color].track,...shouldAnimateOnMount&&{opacity:0,transform:"translate3d(0, 0, 0)"}},border:{label:"progressCircle__border",fill:"none",opacity:1,transition:"all 0.5s",transform:"translate3d(0, 0, 0) scale(1)",...sizeVariants[size].border,...colorVariants[color].border,...shouldAnimateOnMount&&{opacity:0,transform:"translate3d(0, 0, 0) scale(0.75)"}},meter:{label:"progressCircle__meter",fill:"none",transition:"stroke-dashoffset 1s",transform:"translate3d(0, 0, 0)",...sizeVariants[size].meter,...getMeterColorClassName&&meterColorVariants[color][getMeterColorClassName],...shouldAnimateOnMount&&{opacity:0}},radii:(()=>{const camelSize="x-small"===size?"xSmall":size @@ -4945,8 +4957,8 @@ let ProgressCircle=(0,withStyle._)(ProgressCircle_styles,ProgressCircle_theme)(P this.ref=el,"function"==typeof elementRef&&elementRef(el)},this.state={shouldAnimateOnMount:props.shouldAnimateOnMount}}get makeStylesVariables(){return{shouldAnimateOnMount:this.state.shouldAnimateOnMount}}componentDidMount(){var _this$props$makeStyle,_this$props this.state.shouldAnimateOnMount&&this._timeouts.push(setTimeout((()=>{this.setState({shouldAnimateOnMount:!1})}),this.props.animationDelay||500)),null===(_this$props$makeStyle=(_this$props=this.props).makeStyles)||void 0===_this$props$makeStyle||_this$props$makeStyle.call(_this$props,this.makeStylesVariables)}componentDidUpdate(){var _this$props$makeStyle2,_this$props2 null===(_this$props$makeStyle2=(_this$props2=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props2,this.makeStylesVariables)}componentWillUnmount(){this._timeouts.forEach((timeout=>clearTimeout(timeout)))}render(){var _styles$radii,_styles$radii2,_styles$radii3 -const _this$props3=this.props,renderValue=(_this$props3.color,_this$props3.renderValue),formatScreenReaderValue=_this$props3.formatScreenReaderValue,valueNow=(_this$props3.meterColor,_this$props3.valueNow),valueMax=_this$props3.valueMax,screenReaderLabel=_this$props3.screenReaderLabel,styles=(_this$props3.size,_this$props3.styles),props=(0,objectWithoutProperties.A)(_this$props3,ProgressCircle_excluded),valueText="function"==typeof formatScreenReaderValue?formatScreenReaderValue({valueNow,valueMax}):void 0,labelAndValueText=`${screenReaderLabel} ${valueText}`,value=(0,callRenderProp.c)(renderValue,{valueNow,valueMax}),style={strokeDashoffset:`${null==styles?void 0:styles.dashOffset}em`} -return(0,emotion_react_browser_esm.Y)(View.S,Object.assign({},(0,passthroughProps.V)(props),{as:this.props.as,elementRef:this.handleRef,css:null==styles?void 0:styles.progressCircle,margin:this.props.margin}),(0,emotion_react_browser_esm.Y)(ScreenReaderContent.h,null,(0,emotion_react_browser_esm.Y)("progress",{max:valueMax,value:valueNow,"aria-valuetext":valueText,"aria-valuenow":valueNow,"aria-valuemax":valueMax,"aria-label":labelAndValueText})),value&&(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.center,"aria-hidden":"true"},(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.value},value)),(0,emotion_react_browser_esm.Y)("svg",{css:null==styles?void 0:styles.circle,role:"presentation",focusable:"false"},(0,emotion_react_browser_esm.Y)("circle",{css:null==styles?void 0:styles.track,role:"presentation",cx:"50%",cy:"50%",r:null==styles||null===(_styles$radii=styles.radii)||void 0===_styles$radii?void 0:_styles$radii.radius}),(0,emotion_react_browser_esm.Y)("circle",{css:null==styles?void 0:styles.border,role:"presentation",cx:"50%",cy:"50%",r:null==styles||null===(_styles$radii2=styles.radii)||void 0===_styles$radii2?void 0:_styles$radii2.borderOffsetRadius}),(0,emotion_react_browser_esm.Y)("circle",{css:null==styles?void 0:styles.meter,role:"presentation",style,cx:"50%",cy:"50%",r:null==styles||null===(_styles$radii3=styles.radii)||void 0===_styles$radii3?void 0:_styles$radii3.radius})))}},_ProgressCircle.displayName="ProgressCircle",_ProgressCircle.componentId="ProgressCircle",_ProgressCircle.allowedProps=["screenReaderLabel","size","valueMax","valueNow","formatScreenReaderValue","renderValue","color","meterColor","margin","elementRef","as","shouldAnimateOnMount","animationDelay"],_ProgressCircle.propTypes=props_propTypes,_ProgressCircle.defaultProps={formatScreenReaderValue:({valueNow,valueMax})=>`${valueNow} / ${valueMax}`,size:"medium",valueMax:100,valueNow:0,as:"div",color:"primary",shouldAnimateOnMount:!1,meterColor:({valueNow,valueMax})=>valueNow/valueMax>=1?"success":"brand"},ProgressCircle_class=_ProgressCircle))||ProgressCircle_class)||ProgressCircle_class},52576:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" +const _this$props3=this.props,renderValue=(_this$props3.color,_this$props3.renderValue),formatScreenReaderValue=_this$props3.formatScreenReaderValue,valueNow=(_this$props3.meterColor,_this$props3.valueNow),valueMax=_this$props3.valueMax,screenReaderLabel=_this$props3.screenReaderLabel,styles=(_this$props3.size,_this$props3.styles),props=(0,objectWithoutProperties.A)(_this$props3,ProgressCircle_excluded),labelAndValueText=`${screenReaderLabel} ${"function"==typeof formatScreenReaderValue?formatScreenReaderValue({valueNow,valueMax}):void 0}`,value=(0,callRenderProp.c)(renderValue,{valueNow,valueMax}),style={strokeDashoffset:`${null==styles?void 0:styles.dashOffset}em`} +return(0,emotion_react_browser_esm.Y)(View.S,Object.assign({},(0,passthroughProps.V)(props),{as:this.props.as,elementRef:this.handleRef,css:null==styles?void 0:styles.progressCircle,margin:this.props.margin}),(0,emotion_react_browser_esm.Y)(ScreenReaderContent.h,null,(0,emotion_react_browser_esm.Y)("progress",{max:valueMax,value:valueNow,"aria-valuetext":labelAndValueText})),value&&(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.center,"aria-hidden":"true"},(0,emotion_react_browser_esm.Y)("span",{css:null==styles?void 0:styles.value},value)),(0,emotion_react_browser_esm.Y)("svg",{css:null==styles?void 0:styles.circle,role:"presentation",focusable:"false"},(0,emotion_react_browser_esm.Y)("circle",{css:null==styles?void 0:styles.track,role:"presentation",cx:"50%",cy:"50%",r:null==styles||null===(_styles$radii=styles.radii)||void 0===_styles$radii?void 0:_styles$radii.radius}),(0,emotion_react_browser_esm.Y)("circle",{css:null==styles?void 0:styles.border,role:"presentation",cx:"50%",cy:"50%",r:null==styles||null===(_styles$radii2=styles.radii)||void 0===_styles$radii2?void 0:_styles$radii2.borderOffsetRadius}),(0,emotion_react_browser_esm.Y)("circle",{css:null==styles?void 0:styles.meter,role:"presentation",style,cx:"50%",cy:"50%",r:null==styles||null===(_styles$radii3=styles.radii)||void 0===_styles$radii3?void 0:_styles$radii3.radius})))}},_ProgressCircle.displayName="ProgressCircle",_ProgressCircle.componentId="ProgressCircle",_ProgressCircle.allowedProps=["screenReaderLabel","size","valueMax","valueNow","formatScreenReaderValue","renderValue","color","meterColor","margin","elementRef","as","shouldAnimateOnMount","animationDelay"],_ProgressCircle.propTypes=props_propTypes,_ProgressCircle.defaultProps={formatScreenReaderValue:({valueNow,valueMax})=>`${valueNow} / ${valueMax}`,size:"medium",valueMax:100,valueNow:0,as:"div",color:"primary",shouldAnimateOnMount:!1,meterColor:({valueNow,valueMax})=>valueNow/valueMax>=1?"success":"brand"},ProgressCircle_class=_ProgressCircle))||ProgressCircle_class)||ProgressCircle_class},52576:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" __webpack_require__.d(__webpack_exports__,{y:()=>Children}) var react__WEBPACK_IMPORTED_MODULE_0__=__webpack_require__(14041),_makeRequirable__WEBPACK_IMPORTED_MODULE_1__=__webpack_require__(88389) const Children={oneOf(validTypes){function validator(props,propName,componentName){const children=react__WEBPACK_IMPORTED_MODULE_0__.Children.toArray(props[propName]),validTypeNames=validTypes.map((type=>type?getDisplayName(type):type)) @@ -4998,7 +5010,7 @@ let RadioInputGroup=(0,withDeterministicId.G)()(RadioInputGroup_class=(0,testabl this.props.disabled||this.props.readOnly?e.preventDefault():(void 0===this.props.value&&this.setState({value}),"function"==typeof this.props.onChange&&this.props.onChange(e,value))},void 0===props.value&&(this.state={value:props.defaultValue}),this._messagesId=props.deterministicId("RadioInputGroup-messages")}get hasMessages(){return!!this.props.messages&&this.props.messages.length>0}get value(){return void 0===this.props.value?this.state.value:this.props.value}renderChildren(){const _this$props=this.props,children=_this$props.children,name=_this$props.name,variant=_this$props.variant,size=_this$props.size,disabled=_this$props.disabled,readOnly=_this$props.readOnly return react.Children.map(children,((child,index)=>{if((0,matchComponentTypes.w)(child,[RadioInput])){const isChecked=this.value===child.props.value,defaultFocus=!this.value&&0===index return(0,safeCloneElement.Z)(child,{name,disabled:disabled||child.props.disabled,variant,size,checked:isChecked,onChange:this.handleChange,readOnly:readOnly||child.props.readOnly,width:child.props.width||"auto","aria-describedby":this.hasMessages?this._messagesId:void 0,tabIndex:isChecked||defaultFocus?0:-1,label:child.props.label})}return child}))}render(){const _this$props2=this.props,variant=_this$props2.variant,layout=_this$props2.layout,description=_this$props2.description -return react.createElement(es.FormFieldGroup,Object.assign({},(0,omitProps.k)(this.props,RadioInputGroup.allowedProps),(0,pickProps.s)(this.props,es.FormFieldGroup.allowedProps),{description,layout:"columns"===layout&&"toggle"===variant?"stacked":layout,vAlign:"toggle"===variant?"middle":"top",rowSpacing:"small",colSpacing:"toggle"===variant?"none":"small",startAt:"toggle"===variant?"small":void 0,messagesId:this._messagesId,elementRef:this.handleRef}),this.renderChildren())}},_RadioInputGroup.displayName="RadioInputGroup",_RadioInputGroup.componentId="RadioInputGroup",_RadioInputGroup.allowedProps=["name","description","defaultValue","value","onChange","disabled","readOnly","messages","children","variant","size","layout"],_RadioInputGroup.propTypes=props_propTypes,_RadioInputGroup.defaultProps={disabled:!1,variant:"simple",size:"medium",layout:"stacked",readOnly:!1},RadioInputGroup_class=_RadioInputGroup))||RadioInputGroup_class)||RadioInputGroup_class},77650:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" +return react.createElement(es.FormFieldGroup,Object.assign({},(0,omitProps.k)(this.props,RadioInputGroup.allowedProps),(0,pickProps.s)(this.props,es.FormFieldGroup.allowedProps),{description,layout:"columns"===layout&&"toggle"===variant?"stacked":layout,vAlign:"toggle"===variant?"middle":"top",rowSpacing:"small",colSpacing:"toggle"===variant?"none":"small",startAt:"toggle"===variant?"small":void 0,messagesId:this._messagesId,elementRef:this.handleRef,role:"radiogroup"}),this.renderChildren())}},_RadioInputGroup.displayName="RadioInputGroup",_RadioInputGroup.componentId="RadioInputGroup",_RadioInputGroup.allowedProps=["name","description","defaultValue","value","onChange","disabled","readOnly","messages","children","variant","size","layout"],_RadioInputGroup.propTypes=props_propTypes,_RadioInputGroup.defaultProps={disabled:!1,variant:"simple",size:"medium",layout:"stacked",readOnly:!1},RadioInputGroup_class=_RadioInputGroup))||RadioInputGroup_class)||RadioInputGroup_class},77650:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" __webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{RangeInput:()=>RangeInput}) var react=__webpack_require__(14041),es=__webpack_require__(6950),ContextView=__webpack_require__(87137),ui_form_field_es=__webpack_require__(12417),addEventListener=__webpack_require__(86629),withStyle=__webpack_require__(10605),emotion_react_browser_esm=__webpack_require__(15428),testable=__webpack_require__(95982),withDeterministicId=__webpack_require__(54733),omitProps=__webpack_require__(39282),pickProps=__webpack_require__(81134) const styles=(componentTheme,props)=>{const size=props.size,thumbVariant=props.thumbVariant,valueSizeVariants={small:{fontSize:componentTheme.valueSmallFontSize,padding:componentTheme.valueSmallPadding,lineHeight:componentTheme.valueSmallLineHeight},medium:{fontSize:componentTheme.valueMediumFontSize,padding:componentTheme.valueMediumPadding,lineHeight:componentTheme.valueMediumLineHeight},large:{fontSize:componentTheme.valueLargeFontSize,padding:componentTheme.valueLargePadding,lineHeight:componentTheme.valueLargeLineHeight}},trackStyle={borderRadius:"0.312em",borderColor:"transparent",color:"transparent",cursor:"pointer",background:componentTheme.trackBackground,height:`calc(${componentTheme.handleSize} / 2)`},borderedHandleSize=`calc(${componentTheme.handleSize} + (${componentTheme.handleBorderSize} * 2))`,thumbVariantStyle={deprecated:{width:componentTheme.handleSize,height:componentTheme.handleSize,boxShadow:`0 0.0625rem 0 ${componentTheme.handleShadowColor}`},accessible:{width:borderedHandleSize,height:borderedHandleSize,borderWidth:componentTheme.handleBorderSize,borderColor:componentTheme.handleBorderColor,borderStyle:"solid",boxSizing:"border-box",boxShadow:componentTheme.handleShadow}},thumbStyle={appearance:"none",borderRadius:"50%",cursor:"pointer",transition:"all 0.15s ease-in-out",background:componentTheme.handleBackground,...thumbVariantStyle[thumbVariant],"&:hover":{background:componentTheme.handleHoverBackground}},thumbPosition={deprecated:{marginTop:`calc(-1 * ${componentTheme.handleSize} / 4)`},accessible:{marginTop:`calc(-1 * ${borderedHandleSize} / 4)`}},thumbFocusActiveStyle={deprecated:{background:componentTheme.handleFocusBackground,boxShadow:`0 0.0625rem 0 ${componentTheme.handleShadowColor}, 0 0 0 ${componentTheme.handleFocusOutlineWidth} ${componentTheme.handleFocusOutlineColor}`},accessible:{background:componentTheme.handleFocusBackground,boxShadow:componentTheme.handleShadow+", "+`inset 0 0 0 ${componentTheme.handleFocusInset} ${componentTheme.handleFocusBackground}, `+`inset 0 0 0 calc(${componentTheme.handleFocusInset} + ${componentTheme.handleFocusRingSize}) ${componentTheme.handleFocusRingColor}`}} @@ -5015,10 +5027,12 @@ void 0===_this$props.value&&this.setState({value:event.target.value}),"function" null===(_this$props$makeStyle=(_this$props2=this.props).makeStyles)||void 0===_this$props$makeStyle||_this$props$makeStyle.call(_this$props2),null!==this._input&&(this._inputListener=(0,addEventListener.q)(this._input,"input",this.handleChange),this._changeListener=(0,addEventListener.q)(this._input,"change",this.handleChange))}componentWillUnmount(){var _this$_inputListener,_this$_changeListener this._input&&(null===(_this$_inputListener=this._inputListener)||void 0===_this$_inputListener||_this$_inputListener.remove(),null===(_this$_changeListener=this._changeListener)||void 0===_this$_changeListener||_this$_changeListener.remove())}componentDidUpdate(){var _this$props$makeStyle2,_this$props3 null===(_this$props$makeStyle2=(_this$props3=this.props).makeStyles)||void 0===_this$props$makeStyle2||_this$props$makeStyle2.call(_this$props3)}get value(){const value=void 0===this.props.value?this.state.value:this.props.value -return"string"==typeof value?parseInt(value):value}get invalid(){return this.props.messages&&this.props.messages.findIndex((message=>"error"===message.type))>=0}get id(){return this.props.id||this.defaultId}renderValue(){var _this$props$styles -return this.props.displayValue?this.value?(0,emotion_react_browser_esm.Y)(ContextView.v,{background:"inverse",placement:"end center"},(0,emotion_react_browser_esm.Y)("output",{htmlFor:this.id,css:null===(_this$props$styles=this.props.styles)||void 0===_this$props$styles?void 0:_this$props$styles.rangeInputInputValue},this.props.formatValue(this.value,this.props.max))):((0,es.warn)(!1,"RangeInput should have a `value` or `defaultValue` set for the value to be displayed. If no value has to be displayed, set `displayValue={false}`."),null):null}render(){var _this$props$styles2,_this$props$styles3 +return"string"==typeof value?parseInt(value):value}get invalid(){return this.props.messages&&this.props.messages.findIndex((message=>"error"===message.type))>=0}get id(){return this.props.id||this.defaultId}renderValue(){if(this.props.displayValue){var _this$props$styles +if(!this.value)return(0,es.warn)(!1,"RangeInput should have a `value` or `defaultValue` set for the value to be displayed. If no value has to be displayed, set `displayValue={false}`."),null +const props={[RangeInput.outputLocatorAttribute]:this.id} +return(0,emotion_react_browser_esm.Y)(ContextView.v,{background:"inverse",placement:"end center"},(0,emotion_react_browser_esm.Y)("div",Object.assign({},props,{css:null===(_this$props$styles=this.props.styles)||void 0===_this$props$styles?void 0:_this$props$styles.rangeInputInputValue}),this.props.formatValue(this.value,this.props.max)))}return null}render(){var _this$props$styles2,_this$props$styles3 const _this$props4=this.props,formatValue=_this$props4.formatValue,disabled=_this$props4.disabled,readOnly=_this$props4.readOnly,props=(0,omitProps.k)(this.props,RangeInput.allowedProps) -return(0,emotion_react_browser_esm.Y)(ui_form_field_es.FormField,Object.assign({},(0,pickProps.s)(this.props,ui_form_field_es.FormField.allowedProps),{label:this.props.label,id:this.id,elementRef:this.handleRef}),(0,emotion_react_browser_esm.Y)("div",{css:null===(_this$props$styles2=this.props.styles)||void 0===_this$props$styles2?void 0:_this$props$styles2.rangeInput},(0,emotion_react_browser_esm.Y)("input",Object.assign({css:null===(_this$props$styles3=this.props.styles)||void 0===_this$props$styles3?void 0:_this$props$styles3.rangeInputInput,ref:c=>{this._input=c},type:"range",role:"slider",id:this.id,min:this.props.min,max:this.props.max,step:this.props.step,value:this.value,onChange:this.noopChange,"aria-valuenow":this.value,"aria-valuemin":this.props.min,"aria-valuemax":this.props.max,"aria-valuetext":formatValue(this.value,this.props.max)},props,{disabled:disabled||readOnly,"aria-disabled":disabled||readOnly?"true":void 0})),this.renderValue()))}},_RangeInput.displayName="RangeInput",_RangeInput.componentId="RangeInput",_RangeInput.allowedProps=["min","max","defaultValue","value","onChange","messages","size","layout","id","label","displayValue","step","formatValue","inline","disabled","readOnly","thumbVariant"],_RangeInput.propTypes=propTypes,_RangeInput.defaultProps={step:1,formatValue:val=>val,max:0,min:0,inline:!1,size:"medium",layout:"stacked",displayValue:!0,disabled:!1,readOnly:!1,thumbVariant:"deprecated"},_class=_RangeInput))||_class)||_class)||_class},7389:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" +return(0,emotion_react_browser_esm.Y)(ui_form_field_es.FormField,Object.assign({},(0,pickProps.s)(this.props,ui_form_field_es.FormField.allowedProps),{label:this.props.label,id:this.id,elementRef:this.handleRef}),(0,emotion_react_browser_esm.Y)("div",{css:null===(_this$props$styles2=this.props.styles)||void 0===_this$props$styles2?void 0:_this$props$styles2.rangeInput},(0,emotion_react_browser_esm.Y)("input",Object.assign({css:null===(_this$props$styles3=this.props.styles)||void 0===_this$props$styles3?void 0:_this$props$styles3.rangeInputInput,ref:c=>{this._input=c},type:"range",id:this.id,min:this.props.min,max:this.props.max,step:this.props.step,value:this.value,onChange:this.noopChange,"aria-valuetext":formatValue(this.value,this.props.max)},props,{disabled:disabled||readOnly,"aria-disabled":disabled||readOnly?"true":void 0})),this.renderValue()))}},_RangeInput.displayName="RangeInput",_RangeInput.componentId="RangeInput",_RangeInput.outputLocatorAttribute="data-range-output",_RangeInput.allowedProps=["min","max","defaultValue","value","onChange","messages","size","layout","id","label","displayValue","step","formatValue","inline","disabled","readOnly","thumbVariant"],_RangeInput.propTypes=propTypes,_RangeInput.defaultProps={step:1,formatValue:val=>val,max:0,min:0,inline:!1,size:"medium",layout:"stacked",displayValue:!0,disabled:!1,readOnly:!1,thumbVariant:"deprecated"},_class=_RangeInput))||_class)||_class)||_class},7389:(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{"use strict" __webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{Rating:()=>Rating}) var react=__webpack_require__(14041),View=__webpack_require__(37792),ScreenReaderContent=__webpack_require__(77856),omitProps=__webpack_require__(39282),testable=__webpack_require__(95982),IconStarSolid=__webpack_require__(86252),IconStarLightSolid=__webpack_require__(98392),requestAnimationFrame=__webpack_require__(83804),Transition=__webpack_require__(44668),withStyle=__webpack_require__(10605),emotion_react_browser_esm=__webpack_require__(15428) const styles=(componentTheme,props,state)=>{const size=props.size,filled=state.filled,sizeVariants={small:{fontSize:componentTheme.smallIconFontSize},medium:{fontSize:componentTheme.mediumIconFontSize},large:{fontSize:componentTheme.largeIconFontSize}} @@ -5295,7 +5309,9 @@ this.setState({highlightedOptionId:id,inputValue})},this.handleSelectOption=(eve const option=this.getOption("id",id),value=option&&option.props.value this.isControlled?this.setState({isShowingOptions:!1}):this.setState((state=>({isShowingOptions:!1,selectedOptionId:id,inputValue:option?option.props.children:state.inputValue}))),option&&"function"==typeof this.props.onChange&&this.props.onChange(event,{value,id}),"function"==typeof this.props.onHideOptions&&this.props.onHideOptions(event)} const _option=this.getInitialOption(props) -this.state={inputValue:_option?_option.props.children:"",isShowingOptions:!1,highlightedOptionId:void 0,selectedOptionId:_option?_option.props.id:void 0},this._emptyOptionId=props.deterministicId("Select-EmptyOption")}get _select(){return this.ref}focus(){this.ref&&this.ref.focus()}get focused(){return!!this.ref&&this.ref.focused}get id(){return this.ref?this.ref.id:void 0}get isControlled(){return void 0!==this.props.value}get interaction(){return(0,getInteraction.H)({props:this.props})}componentDidUpdate(prevProps){if(this.props.value!==prevProps.value){let option=this.getOption("value",this.props.value) +this.state={inputValue:_option?_option.props.children:"",isShowingOptions:!1,highlightedOptionId:void 0,selectedOptionId:_option?_option.props.id:void 0},this._emptyOptionId=props.deterministicId("Select-EmptyOption")}get _select(){return this.ref}focus(){this.ref&&this.ref.focus()}get focused(){return!!this.ref&&this.ref.focused}get id(){return this.ref?this.ref.id:void 0}get isControlled(){return void 0!==this.props.value}get interaction(){return(0,getInteraction.H)({props:this.props})}hasOptionsChanged(prevChildren,currentChildren){const getValues=children=>react.Children.map(children,(child=>react.isValidElement(child)?child.props.value:null)),prevValues=getValues(prevChildren),currentValues=getValues(currentChildren) +return JSON.stringify(prevValues)!==JSON.stringify(currentValues)}componentDidUpdate(prevProps){if(this.hasOptionsChanged(prevProps.children,this.props.children)){const option=this.getOption("value",this.state.inputValue) +this.setState({inputValue:option?option.props.children:void 0,selectedOptionId:option?option.props.id:""})}if(this.props.value!==prevProps.value){let option=this.getOption("value",this.props.value) void 0===this.props.value&&(option=this.getOption("value",prevProps.value)),this.setState({inputValue:option?option.props.children:"",selectedOptionId:option?option.props.id:""})}}getInitialOption(props){const value=props.value,defaultValue=props.defaultValue,initialValue=value||defaultValue return"string"==typeof initialValue||"number"==typeof initialValue?this.getOption("value",initialValue):this.getFirstOption()}getOptionLabelById(id){const option=this.getOption("id",id) return option?option.props.children:""}getFirstOption(){const children=react.Children.toArray(this.props.children) @@ -5639,7 +5655,7 @@ return(0,emotion_react_browser_esm.Y)(es.FormField,Object.assign({},(0,pickProps __webpack_require__.d(__webpack_exports__,{k:()=>TextInput}) var objectWithoutProperties=__webpack_require__(14223),react=__webpack_require__(14041),withDeterministicId=__webpack_require__(54733),getInteraction=__webpack_require__(81251),passthroughProps=__webpack_require__(38419),callRenderProp=__webpack_require__(54058),addEventListener=__webpack_require__(86629),isActiveElement=__webpack_require__(8732),es=__webpack_require__(12417),testable=__webpack_require__(95982),withStyle=__webpack_require__(10605),emotion_react_browser_esm=__webpack_require__(15428) const styles=(componentTheme,props,state)=>{const size=props.size,textAlign=props.textAlign,shouldNotWrap=props.shouldNotWrap,disabled=state.disabled,invalid=state.invalid,focused=state.focused,beforeElementHasWidth=state.beforeElementHasWidth,afterElementHasWidth=state.afterElementHasWidth,sizeVariants={small:{fontSize:componentTheme.smallFontSize,height:`calc(${componentTheme.smallHeight} - (2 * ${componentTheme.borderWidth}))`,lineHeight:`calc(${componentTheme.smallHeight} - (2 * ${componentTheme.borderWidth}))`},medium:{fontSize:componentTheme.mediumFontSize,height:`calc(${componentTheme.mediumHeight} - (2 * ${componentTheme.borderWidth}))`,lineHeight:`calc(${componentTheme.mediumHeight} - (2 * ${componentTheme.borderWidth}))`},large:{fontSize:componentTheme.largeFontSize,height:`calc(${componentTheme.largeHeight} - (2 * ${componentTheme.borderWidth}))`,lineHeight:`calc(${componentTheme.largeHeight} - (2 * ${componentTheme.borderWidth}))`}},disabledStyle=disabled?{cursor:"not-allowed",pointerEvents:"none",opacity:"0.5"}:{},focusedStyle=focused?{opacity:1,transform:"scale(1)"}:{opacity:0,transform:"scale(0.95)"},invalidStyle=invalid?{borderColor:componentTheme.errorBorderColor}:{},invalidAndFocusedStyle=invalid&&focused?{borderColor:componentTheme.errorBorderColor}:{},inputStyle={all:"initial","&::-ms-clear":{display:"none"},WebkitFontSmoothing:"antialiased",MozOsxFontSmoothing:"grayscale",appearance:"none",margin:0,width:"100%",display:"block",boxSizing:"border-box",outline:"none",fontFamily:componentTheme.fontFamily,fontWeight:componentTheme.fontWeight,color:componentTheme.color,padding:`0 ${componentTheme.padding}`,background:"transparent",border:"none",verticalAlign:"baseline",'&[autocomplete="off"]::-webkit-contacts-auto-fill-button':{display:"none !important"},"&:focus":{boxShadow:"initial"},"&::placeholder":{color:componentTheme.placeholderColor},...sizeVariants[size],textAlign},viewBase={boxSizing:"border-box",fontFamily:componentTheme.fontFamily,maxWidth:"100%",overflow:"visible",unicodeBidi:"isolate"},flexBase={...viewBase,display:"flex",alignItems:"center",justifyContent:"flex-start",flexDirection:"row"},flexItemBase={...viewBase,flexShrink:0} -return{textInput:{label:"textInput",...inputStyle,"&:is(input)[type]":inputStyle,"&:-webkit-any(input)[type]":inputStyle},facade:{label:"textInput__facade",position:"relative",display:"block",boxSizing:"border-box",border:`${componentTheme.borderWidth} ${componentTheme.borderStyle} ${componentTheme.borderColor}`,borderRadius:componentTheme.borderRadius,background:componentTheme.background,color:componentTheme.color,"&::before":{content:'""',pointerEvents:"none",position:"absolute",display:"block",boxSizing:"border-box",top:"-0.25rem",bottom:"-0.25rem",left:"-0.25rem",right:"-0.25rem",border:`${componentTheme.focusOutlineWidth} ${componentTheme.focusOutlineStyle} ${componentTheme.focusOutlineColor}`,borderRadius:`calc(${componentTheme.borderRadius} * 1.5)`,transition:"all 0.2s",...focusedStyle,...invalidAndFocusedStyle},...disabledStyle,...invalidStyle},layout:{label:"textInput__layout",...flexBase,...!shouldNotWrap&&{flexWrap:"wrap"}},beforeElement:{label:"textInput__beforeElement",...flexItemBase,paddingInlineStart:componentTheme.padding,...!1===beforeElementHasWidth&&{paddingInlineStart:0}},innerWrapper:{label:"textInput__innerWrapper",...flexItemBase,minWidth:"0.0625rem",flexShrink:1,flexGrow:1},inputLayout:{label:"textInput__inputLayout",...flexBase},afterElement:{marginTop:"-1px",marginBottom:"-1px",label:"textInput__afterElement",...flexItemBase,paddingInlineEnd:componentTheme.padding,...!1===afterElementHasWidth&&{paddingInlineEnd:0}}}},theme=theme=>{var _colors$contrasts,_colors$contrasts2,_colors$contrasts3,_colors$contrasts4,_colors$contrasts5,_colors$contrasts6,_colors$contrasts7 +return{textInput:{label:"textInput",...inputStyle,"&:is(input)[type]":inputStyle,"&:-webkit-any(input)[type]":inputStyle},facade:{label:"textInput__facade",position:"relative",display:"block",boxSizing:"border-box",border:`${componentTheme.borderWidth} ${componentTheme.borderStyle} ${componentTheme.borderColor}`,borderRadius:componentTheme.borderRadius,background:componentTheme.background,color:componentTheme.color,"&::before":{content:'""',pointerEvents:"none",position:"absolute",display:"block",boxSizing:"border-box",top:"-0.25rem",bottom:"-0.25rem",left:"-0.25rem",right:"-0.25rem",border:`${componentTheme.focusOutlineWidth} ${componentTheme.focusOutlineStyle} ${componentTheme.focusOutlineColor}`,borderRadius:`calc(${componentTheme.borderRadius} * 1.5)`,transition:"all 0.2s",...focusedStyle,...invalidAndFocusedStyle},...disabledStyle,...invalidStyle},layout:{label:"textInput__layout",...flexBase,...!shouldNotWrap&&{flexWrap:"wrap"}},beforeElement:{display:"inline-flex",alignItems:"center",label:"textInput__beforeElement",...flexItemBase,paddingInlineStart:componentTheme.padding,...!1===beforeElementHasWidth&&{paddingInlineStart:0}},innerWrapper:{label:"textInput__innerWrapper",...flexItemBase,minWidth:"0.0625rem",flexShrink:1,flexGrow:1},inputLayout:{label:"textInput__inputLayout",...flexBase},afterElement:{marginTop:"-1px",marginBottom:"-1px",label:"textInput__afterElement",...flexItemBase,paddingInlineEnd:componentTheme.padding,...!1===afterElementHasWidth&&{paddingInlineEnd:0}}}},theme=theme=>{var _colors$contrasts,_colors$contrasts2,_colors$contrasts3,_colors$contrasts4,_colors$contrasts5,_colors$contrasts6,_colors$contrasts7 const colors=theme.colors,typography=theme.typography,borders=theme.borders,spacing=theme.spacing,forms=theme.forms,themeName=theme.key,themeSpecificStyle={canvas:{color:theme["ic-brand-font-color-dark"],focusOutlineColor:theme["ic-brand-primary"]}} return{...{fontFamily:null==typography?void 0:typography.fontFamily,fontWeight:null==typography?void 0:typography.fontWeightNormal,borderWidth:null==borders?void 0:borders.widthSmall,borderStyle:null==borders?void 0:borders.style,borderColor:null==colors||null===(_colors$contrasts=colors.contrasts)||void 0===_colors$contrasts?void 0:_colors$contrasts.grey1214,borderRadius:null==borders?void 0:borders.radiusMedium,color:null==colors||null===(_colors$contrasts2=colors.contrasts)||void 0===_colors$contrasts2?void 0:_colors$contrasts2.grey125125,background:null==colors||null===(_colors$contrasts3=colors.contrasts)||void 0===_colors$contrasts3?void 0:_colors$contrasts3.white1010,padding:null==spacing?void 0:spacing.small,focusOutlineWidth:null==borders?void 0:borders.widthMedium,focusOutlineStyle:null==borders?void 0:borders.style,focusOutlineColor:null==colors||null===(_colors$contrasts4=colors.contrasts)||void 0===_colors$contrasts4?void 0:_colors$contrasts4.blue4570,errorBorderColor:null==colors||null===(_colors$contrasts5=colors.contrasts)||void 0===_colors$contrasts5?void 0:_colors$contrasts5.red4570,errorOutlineColor:null==colors||null===(_colors$contrasts6=colors.contrasts)||void 0===_colors$contrasts6?void 0:_colors$contrasts6.red4570,placeholderColor:null==colors||null===(_colors$contrasts7=colors.contrasts)||void 0===_colors$contrasts7?void 0:_colors$contrasts7.grey4570,smallFontSize:null==typography?void 0:typography.fontSizeSmall,smallHeight:null==forms?void 0:forms.inputHeightSmall,mediumFontSize:null==typography?void 0:typography.fontSizeMedium,mediumHeight:null==forms?void 0:forms.inputHeightMedium,largeFontSize:null==typography?void 0:typography.fontSizeLarge,largeHeight:null==forms?void 0:forms.inputHeightLarge},...themeSpecificStyle[themeName]}} var prop_types=__webpack_require__(39067),prop_types_default=__webpack_require__.n(prop_types),controllable=__webpack_require__(81720) @@ -6402,12 +6418,12 @@ for(;0{"use strict" module.exports=__webpack_require__.p+"d05f4d6060f49b5c7b97.jpg"},38172:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" module.exports=__webpack_require__.p+"28b1b00c4cc6321cd85d.jpg"},94736:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"7566b3be181dcf49fec6.eot"},99306:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"994f7dea80b34aa4691b.ttf"},17114:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"49e6e8799cb6ec6857af.woff"},37134:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"0661ef6853ec82f17418.eot"},2744:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"15a5b3f4610a9b1b3d26.ttf"},86712:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" -module.exports=__webpack_require__.p+"81357bec16c11cb058ef.woff"},93822:module=>{"use strict" +module.exports=__webpack_require__.p+"06a08f6e0c92d8f3d28a.eot"},99306:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"32c18c125387e88f9120.ttf"},17114:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"e7b3f60c4301185b39cc.woff"},37134:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"c8036fe200dd8d7701b9.eot"},2744:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"34e1595fa073ccba9042.ttf"},86712:(module,__unused_webpack_exports,__webpack_require__)=>{"use strict" +module.exports=__webpack_require__.p+"5aa5decd41057c35b521.woff"},93822:module=>{"use strict" module.exports='\n \n\n'},24321:module=>{"use strict" module.exports="FPO: {{w}} x {{h}}\n"},12679:module=>{"use strict" module.exports='\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n'},51665:module=>{"use strict"