ayo/lion
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(overlays): documentation overlayController config

Browse source
This commit is contained in:
Thijs Louisse 2020-05-17 18:01:38 +02:00
parent 810bdad523
commit dca848e0ac
1 changed files with 36 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
packages/overlays/src/utils/typedef.js
View file

@ -1,32 +1,50 @@
/** /**
* @typedef {object} OverlayConfig * @typedef {object} OverlayConfig
* @property {HTMLElement} [elementToFocusAfterHide=document.body] - the element that should be * @property {HTMLElement} [elementToFocusAfterHide=document.body] the element that should be
* called `.focus()` on after dialog closes * called `.focus()` on after dialog closes
* @property {boolean} [hasBackdrop=false] - whether it should have a backdrop (currently * @property {boolean} [hasBackdrop=false] whether it should have a backdrop (currently
* exclusive to globalOverlayController) * exclusive to globalOverlayController)
* @property {boolean} [isBlocking=false] - hides other overlays when mutiple are opened * @property {boolean} [isBlocking=false] hides other overlays when mutiple are opened
* (currently exclusive to globalOverlayController) * (currently exclusive to globalOverlayController)
* @property {boolean} [preventsScroll=false] - prevents scrolling body content when overlay * @property {boolean} [preventsScroll=false] prevents scrolling body content when overlay
* opened (currently exclusive to globalOverlayController) * opened (currently exclusive to globalOverlayController)
* @property {boolean} [trapsKeyboardFocus=false] - rotates tab, implicitly set when 'isModal' * @property {boolean} [trapsKeyboardFocus=false] rotates tab, implicitly set when 'isModal'
* @property {boolean} [hidesOnEsc=false] - hides the overlay when pressing [ esc ] * @property {boolean} [hidesOnEsc=false] hides the overlay when pressing [ esc ]
* @property {boolean} [hidesOnOutsideClick=false] - hides the overlay when clicking next to it, * @property {boolean} [hidesOnOutsideClick=false] hides the overlay when clicking next to it,
* exluding invoker. (currently exclusive to localOverlayController) * exluding invoker. (currently exclusive to localOverlayController)
* https://github.com/ing-bank/lion/pull/61 * https://github.com/ing-bank/lion/pull/61
* @property {HTMLElement} invokerNode * @property {'max'|'full'|'min'|'none'} [inheritsReferenceWidth='none'] will align contentNode
* @property {HTMLElement} contentNode * with referenceNode (invokerNode by default) for local overlays. Usually needed for dropdowns.
* @property {boolean} [isModal=false] - sets aria-modal and/or aria-hidden="true" on siblings * 'max' will prevent contentNode from exceeding width
* @property {boolean} [isGlobal=false] - determines the connection point in DOM (body vs next * of referenceNode, 'min' guarantees that contentNode will be at least as wide as referenceNode.
* to invoker). This is what other libraries often refer to as 'portal'. * 'full' will make sure that the invoker width always is the same.
* @property {boolean} [isTooltip=false] - has a totally different interaction- and accessibility pattern from all other overlays, so needed for internals. * @property {HTMLElement} invokerNode the interactive element (usually a button) invoking the
* @property {boolean} [handlesUserInteraction] - sets toggle on click, or hover when `isTooltip` * dialog or tooltip
* @property {boolean} [handlesAccessibility] - * @property {HTMLElement} [referenceNode] the element that is used to position the overlay content
* - For non `isTooltip`: * relative to. Usually, this is the same element as invokerNode. Should only be provided whne
* @property {HTMLElement} contentNode the most important element: the overlay itself.
* @property {HTMLElement} [contentWrapperNode] the wrapper element of contentNode, used to supply
* inline positioning styles. When a Popper arrow is needed, it acts as parent of the arrow node.
* Will be automatically created for global and non projected contentNodes.
* Required when used in shadow dom mode or when Popper arrow is supplied. Essential for allowing
* webcomponents to style their projected contentNodes.
* @property {HTMLElement} [backdropNode] the element that is placed behin the contentNode. When
* not provided and `hasBackdrop` is true, a backdropNode will be automatically created
* @property {'global'|'local'} placementMode determines the connection point in DOM (body vs next
* to invoker).
* @property {boolean} [isTooltip=false] has a totally different interaction- and accessibility
* pattern from all other overlays. Will behave as role="tooltip" element instead of a role="dialog"
* element.
* @property {boolean} [handlesAccessibility]
* For non `isTooltip`:
* - sets aria-expanded="true/false" and aria-haspopup="true" on invokerNode * - sets aria-expanded="true/false" and aria-haspopup="true" on invokerNode
* - sets aria-controls on invokerNode * - sets aria-controls on invokerNode
* - returns focus to invokerNode on hide * - returns focus to invokerNode on hide
* - sets focus to overlay content(?) * - sets focus to overlay content(?)
* - For `isTooltip`: *
* For `isTooltip`:
* - sets role="tooltip" and aria-labelledby/aria-describedby on the content * - sets role="tooltip" and aria-labelledby/aria-describedby on the content
* @property {PopperConfig} popperConfig * @property {object} popperConfig popper configuration. Will be used when placementMode is 'local'
* @property {object} viewportConfig viewport configuration. Will be used when placementMode is
* 'global'
*/ */