diff --git a/docs/app/templates/public-pages/docs/api-reference.gts b/docs/app/templates/public-pages/docs/api-reference.gts index a6a64391..5bcd20c7 100644 --- a/docs/app/templates/public-pages/docs/api-reference.gts +++ b/docs/app/templates/public-pages/docs/api-reference.gts @@ -26,23 +26,6 @@ import { LinkTo } from '@ember/routing'; Function Function to customize how the content of the dropdown is positioned. - - class - String - The class of the dropdown component. Since this component is tagless - by default, you need to combine it with the - tagName - to be effective - - - defaultClass - String - Another way of providing a class to the component without polluting - the - class - attribute. Useful in contextual component to allow users give their - own classes while still retaining some defaults - destination String @@ -57,14 +40,6 @@ import { LinkTo } from '@ember/routing'; dropdown will be rendered using #in-element - - contentComponent - Component - The component to render as content instead of the default content - component. You - probably - don't want to use this option. - horizontalPosition String @@ -72,9 +47,28 @@ import { LinkTo } from '@ember/routing'; auto (the default), left, - center + right, + center, + auto-left or - right + auto-right + + + verticalPosition + String + The vertical positioning strategy of the content. Can be one of + auto + (the default), + above + or + below + + + disabled + Boolean + (Default: + false). Flag that disables opening and closing of the + dropdown. matchTriggerWidth @@ -112,9 +106,11 @@ import { LinkTo } from '@ember/routing'; alter its behavior. The user can close it as usual. - tagName - String - (Default: "") The tag of the component. + rootEventType + String + (Default: + 'click') The type of mouse event that handles closing the + dropdown. Valid values: "mousedown" and "click" triggerComponent @@ -128,14 +124,12 @@ import { LinkTo } from '@ember/routing'; (Default: 'div') The tag of the trigger component - verticalPosition - String - The vertical positioning strategy of the content. Can be one of - auto - (the default), - above - or - below + contentComponent + Component + The component to render as content instead of the default content + component. You + probably + don't want to use this option. registerAPI @@ -143,6 +137,11 @@ import { LinkTo } from '@ember/routing'; An action that will be invoked with the new public API of the component every time there is a change in the state of the component. + + onInit + Function + Action that will be called when the component is initialized. + onOpen Function @@ -152,20 +151,13 @@ import { LinkTo } from '@ember/routing'; from this function will prevent the component from being opened. - onClose + onClose Function Action that will be called when the component is about to close. Returning false from this function will prevent the component from being closed. - - rootEventType - String - (Default: - 'click') The type of mouse event that handles closing the - dropdown. Valid values: "mousedown" and "click" - @@ -181,62 +173,77 @@ import { LinkTo } from '@ember/routing'; - ariaDescribedBy + eventType String - Maps to aria-described-by + (Default: + 'click') The type of mouse event that triggers the + trigger. Valid values: "mousedown" and "click" - ariaInvalid + stopPropagation Boolean - Maps to aria-invalid + (Default: + false) Whether the trigger should prevent the propagation + of the event that triggers it (click or mousedown) - ariaLabel - String - Maps to aria-label + defaultClass + String + Another way of providing a class to the component without polluting + the + class + attribute. Useful in contextual component to allow users give their + own classes while still retaining some defaults - ariaLabelledBy - String - Maps to aria-labeledby + onBlur + Function + Action that is executed on blur events. - class - String - Extra classes to be added to the trigger components + onClick + Function + Action that is executed on click events. - tabindex - Number - Tabindex of the trigger, which defaults to 0 so the trigger is - focusable by default + onFocus + Function + Action that is executed on focus events. - htmlTag - String - (Default: - 'div') The tag of the trigger component (Note: If you are - using the yielded trigger component, please use - @triggerHtmlTag) + onFocusIn + Function + Action that is executed on focus-in events. - title - String - Maps to the title attribute + onFocusOut + Function + Action that is executed on focus-out events. - eventType - String - (Default: - 'click') The type of mouse event that triggers the - trigger. Valid values: "mousedown" and "click" + onKeyDown + Function + Action that is executed on keydown events. - stopPropagation - Boolean - (Default: - false) Whether the trigger should prevent the propagation - of the event that triggers it (click or mousedown) + onMouseDown + Function + Action that is executed on mouse down events. + + + onMouseEnter + Function + Action that is executed on mouse enter events. + + + onMouseLeave + Function + Action that is executed on mouse leave events. + + + onTouchEnd + Function + Action that is executed on touch end events. @@ -252,11 +259,6 @@ import { LinkTo } from '@ember/routing'; - - class - String - The class of the dropdown's content - animationEnabled boolean @@ -282,6 +284,62 @@ import { LinkTo } from '@ember/routing'; >MutationRecord and the public API object. + + transitioningInClass + String + Allow to customize the classes used for animations + + + transitioningOutClass + String + Allow to customize the classes used for animations + + + transitionedInClass + String + Allow to customize the classes used for animations + + + isTouchDevice + boolean + Forces adding touch events. By default we do auto-detected + + + overlay + boolean + Renders the dropdown content as an overlay (see example). + + + defaultClass + String + Another way of providing a class to the component without polluting + the + class + attribute. Useful in contextual component to allow users give their + own classes while still retaining some defaults + + + onFocusIn + Function + Action that is executed on focus-in events. + + + onFocusOut + Function + Action that is executed on focus-out events. + + + onMouseEnter + Function + Action that is executed on mouse enter events. + + + onMouseLeave + Function + Action that is executed on mouse leave events. + @@ -309,6 +367,9 @@ import { LinkTo } from '@ember/routing'; open() { ... }, // Opens the dropdown reposition() { ... }, // Repositions the dropdown toggle() { ... } // Toggles the dropdown + registerTriggerElement() { ... }, Gives option to register the trigger element + registerDropdownElement() { ... }, Gives option to register the dropdown element + getTriggerElement() { ... } Return HTMLElement from registered trigger element } }