Typedef

Static Public Summary
public	AccordionVariantEnum: Object Enumeration for Accordion variants.
public	ActionBarContainerPositionEnum: Object Enumeration for ActionBarContainer positions.
public	AlertSizeEnum: Object Enumeration for Alert sizes.
public	AlertVariantEnum: Object Enumeration for Alert variants.
public	AutocompleteMatchEnum: Object Enumeration for Autocomplete match options.
public	AutocompleteSuggestion: Object A suggestion object.
public	AutocompleteVariantEnum: Object Enumeration for Autocomplete variants.
public	BannerVariantEnum: Object Enumeration for Banner variants.
public	BaseFieldGroupOrientationEnum: Object Enumeration for BaseFieldGroup orientations.
public	ButtonGroupSelectionModeEnum: Object Enumeration for ButtonGroup selection options.
public	ButtonIconPositionEnum: Object Enumeration for BaseButton icon position options.
public	ButtonIconSizeEnum: Object Enumeration for Button, AnchorButton icon sizes.
public	ButtonSizeEnum: Object Enumeration for BaseButton sizes.
public	ButtonVariantEnum: Object Enumeration for Button, AnchorButton variants.
public	CardVariantEnum: Object Enumeration for Card variants.
public	CharacterCountTargetEnum: Object Enumeration for CharacterCount targets.
public	ClockVariantEnum: Object Enumeration for Clock variants.
public	CoachMarkSizeEnum: Object Enumeration for CoachMark sizes.
public	CoachMarkVariantEnum: Object Enumeration for CoachMark variants.
public	CollectionFilter(element: HTMLElement): Boolean: function Signature of the function called to determine if an element should be included in the Collection.
public	CollectionOnChange(addedNodes: Array<HTMLElement>, removedNodes: Array<HTMLElement>): function Signature of the function called when there is a change in the Collection.
public	CollectionOnItemAdded(item: HTMLElement): function Signature of the function called when ever an item is added to the Collection.
public	CollectionOnItemRemoved(item: HTMLElement): function Signature of the function called when ever an item is removed from the Collection.
public	ColorInputAutoGenerateColorsEnum: Object Enumeration for ColorInput auto generated colors options.
public	ColorInputShowDefaultColorsEnum: Object Enumeration for ColorInput default colors display options.
public	ColorInputShowPropertiesEnum: Object Enumeration for ColorInput color properties display options.
public	ColorInputShowSwatchesEnum: Object Enumeration for ColorInput swatches display options.
public	ColorInputVariantEnum: Object Enumeration for ColorInput variants.
public	ColumnViewItemVariantEnum: Object Enumeration for ColumnViewItem variants.
public	ColumnViewSelectionModeEnum: Object Enumeration for ColumnView selection options.
public	CycleButtonDisplayModeEnum: Object Enumeration for CycleButton display options.
public	CycleButtonItemDisplayModeEnum: Object Enum for {CycleButtonItem} display options.
public	DatepickerTypeEnum: Object Enumeration for Datepicker variants.
public	DatepickerVariantEnum: Object Enum for Datepicker variant values.
public	DialogBackdropEnum: Object Enumeration for Dialog backdrops.
public	DialogClosableEnum: Object Enumeration for Dialog closable options.
public	DialogInteractionEnum: Object Enumeration for Dialog keyboard interaction options.
public	DialogVariantEnum: Object Enumeration for Dialog variants.
public	DragActionAxisEnum: Object Enumeration for DragAction axis restrictions.
public	DrawerDirectionEnum: Object Enumeration for Drawer directions.
public	FileUploadItemResponseTypeEnum: Object Enumeration for FileUploadItem response types.
public	FileUploadMethodEnum: Object Enumeration for FileUpload HTTP methods that can be used to upload files.
public	I18nLocalesEnum: Object Enumeration for i18n locales.
public	IconAutoAriaLabelEnum: Object Enumeration for Icon autoAriaLabel value.
public	IconSizeEnum: Object Enumeration for Icon sizes.
public	ListInteractionEnum: Object Enumeration for BaseList interactions.
public	MasonryAriaGridEnum: Object Enumeration values to enable/disable aria grid support for Masonry.
public	MasonryLayoutsEnum: Object Enumeration for Masonry layouts.
public	MasonrySelectionModeEnum: Object Enumeration for Masonry selection options.
public	OverlayAlignEnum: Object this typedef was deprecated. Enumeration for Overlay alignment pairs.
public	OverlayCollisionEnum: Object Enumeration for Overlay collision detection strategies.
public	OverlayFadeTime: Number The time it should take for BaseOverlay to fade in milliseconds.
public	OverlayFocusOnShowEnum: Object Enumeration for BaseOverlay focus behavior options.
public	OverlayInteractionEnum: Object Enumeration for Overlay interaction values.
public	OverlayPlacementEnum: Object Enumeration for Overlay placement values.
public	OverlayReturnFocusEnum: Object Enumeration for BaseOverlay return focus options.
public	OverlayScrollOnFocusEnum: Object Enumeration for BaseOverlay scroll focus options.
public	OverlayTargetEnum: Object Enumeration for Overlay anchored overlay targets.
public	OverlayTrapFocusEnum: Object Enumeration for BaseOverlay trap options.
public	PopoverClosableEnum: Object Enumeration for Popover closable state.
public	PopoverVariantEnum: Object Enumeration for Popover variants.
public	ProgressLabelPositionEnum: Object Enumeration for Progress label positions.
public	ProgressSizeEnum: Object Enumeration for Progress sizes.
public	QuickActionsInteractionEnum: Object Enumeration for QuickActions interaction options.
public	QuickActionsItemTypeEnum: Object Enumeration for QuickActionsItem type values.
public	QuickActionsPlacementEnum: Object Enumeration for QuickActions placement options.
public	QuickActionsTargetEnum: Object Enumeration for QuickActions anchored overlay target options.
public	RadioGroupOrientationEnum: Object Enumeration for RadioGroup orientations.
public	SearchVariantEnum: Object Enumeration for Search variants.
public	SelectVariantEnum: Object Enumeration for Select variants.
public	ShellHelpResult: Object A search result object.
public	ShellMenuBarItemHasPopupRoleEnum: Object Enumeration for valid aria-haspopup values.
public	ShellMenuBarItemIconVariantEnum: Object Enumeration for ShellMenuBarItem icon variants.
public	ShellUserAvatarEnum: Object Enumeration for ShellUser avatar options.
public	SideNavVariantEnum: Object Enumeration for SideNav variants.
public	SliderOrientationEnum: Object Enumeration for Slider orientations.
public	SplitButtonVariantEnum: Object Enumeration for SplitButton variants.
public	StatusColorEnum: Object Enumeration for Status colors.
public	StatusVariantEnum: Object Enumeration for Status variants.
public	StepListInteractionEnum: Object Enumeration for StepList interaction options.
public	StepListSizeEnum: Object Enumeration for StepList sizes.
public	TabListOrientationEnum: Object Enumeration for TabList orientations.
public	TabListSizeEnum: Object Enumeration for TabList sizes.
public	TabViewOrientationEnum: Object Enumeration for TabView orientations.
public	TableColumnAlignmentEnum: Object Enumeration for TableColumn alignment options.
public	TableColumnSortableDirectionEnum: Object Enumeration for TableColumn sortable direction options.
public	TableColumnSortableTypeEnum: Object Enumeration for TableColumn sortable type options.
public	TableSectionDividerEnum: Object Enumeration for TableHead, TableBody and TableFoot divider values.
public	TableVariantEnum: Object Enumeration for Table variants
public	TagColorEnum: Object Enumeration for Tag colors.
public	TagSizeEnum: Object Enumeration for Tag sizes.
public	TextareaVariantEnum: Object Enumeration for Textarea variants.
public	TextfieldVariantEnum: Object Enumeration for Textfield variants.
public	ToastPlacementEnum: Object Enumeration for Toast placement values.
public	ToastVariantEnum: Object Enumeration for Toast variants.
public	TooltipVariantEnum: Object Enumeration for Tooltip variants.
public	TrackingEnum: Object Enumeration representing the tracking options.
public	TreeItemVariantEnum: Object Enumeration for TreeItem variants.
public	WaitSizeEnum: Object Enumeration for Wait sizes.
public	WaitVariantEnum: Object Enumeration for Wait variants.
public	coral-accordion:change: CustomEvent Triggered when Accordion selected item has changed.
public	coral-autocomplete:hidesuggestions: CustomEvent Triggered when the Autocomplete hides the suggestions.
public	coral-autocomplete:showsuggestions: CustomEvent Triggered when the Autocomplete could accept external data to be loaded by the user.
public	coral-collection:add: CustomEvent Triggered when an item is added to the Collection.
public	coral-collection:remove: CustomEvent Triggered when an item is removed from a Collection.
public	coral-columnview:activeitemchange: CustomEvent Triggered when the active item of the ColumnViewColumn changes.
public	coral-columnview:change: CustomEvent Triggered when the selection inside the ColumnViewColumn changes.
public	coral-columnview:loaditems: CustomEvent Triggered when additional items can be loaded into the ColumnView.
public	coral-columnview:navigate: CustomEvent Triggered when the ColumnView navigation is complete and the new columns are ready.
public	coral-cyclebutton:change: CustomEvent Triggered when the CycleButton selected item has changed.
public	coral-dragaction:drag: CustomEvent Triggered when the DragAction#dragElement is being dragged.
public	coral-dragaction:dragend: CustomEvent Triggered when the DragAction#dragElement stops to be dragged.
public	coral-dragaction:dragendonkey: CustomEvent Triggered when the DragAction#dragElement is dropped on key.
public	coral-dragaction:dragenter: CustomEvent Triggered when the DragAction#dragElement enters a drop element.
public	coral-dragaction:dragleave: CustomEvent Triggered when the DragAction#dragElement leaves a drop element.
public	coral-dragaction:dragonkeyfocusout: CustomEvent Triggered when the DragAction#dragElement is losing focus.
public	coral-dragaction:dragonkeyspace: CustomEvent Triggered when the DragAction#dragElement is selected to be dragged.
public	coral-dragaction:dragover: CustomEvent Triggered when the DragAction#dragElement is over a drop element.
public	coral-dragaction:dragoveronkeyarrowdown: CustomEvent Triggered when the DragAction#dragElement is moved on arrow down pressed.
public	coral-dragaction:dragoveronkeyarrowup: CustomEvent Triggered when the DragAction#dragElement is moved on arrow up pressed.
public	coral-dragaction:dragstart: CustomEvent Triggered when the DragAction#dragElement starts to be dragged.
public	coral-dragaction:drop: CustomEvent Triggered when the DragAction#dragElement is dropped on a drop element.
public	coral-drawer:close: CustomEvent Triggered when the Drawer is closed.
public	coral-drawer:open: CustomEvent Triggered when the Drawer is opened.
public	coral-masonry:change: CustomEvent Triggered when Masonry selected item has changed.
public	coral-masonry:order: CustomEvent Triggered when a Masonry item is reordered.
public	coral-multifield:beforeitemorder: CustomEvent Triggered when the Multifield item are reordered.
public	coral-multifield:itemorder: CustomEvent Triggered when the Multifield item are reordered.
public	coral-overlay:beforeclose: CustomEvent Triggered before the BaseOverlay is closed with `hide()` or `instance.open = false`.
public	coral-overlay:beforeopen: CustomEvent Triggered before the BaseOverlay is opened with `show()` or `instance.open = true`.
public	coral-overlay:close: CustomEvent Triggered after the BaseOverlay is closed with `hide()` or `instance.open = false`
public	coral-overlay:open: CustomEvent Triggered after the BaseOverlay is opened with `show()` or `instance.open = true`
public	coral-overlay:positioned: CustomEvent Triggered after the Overlay is positioned.
public	coral-panelstack:change: CustomEvent Triggered when PanelStack selected panel has changed.
public	coral-progress:change: CustomEvent Triggered when the Progress value is changed.
public	coral-search:clear: CustomEvent Triggered when the Search is cleared.
public	coral-search:input: CustomEvent Triggered when Search input is given.
public	coral-search:submit: CustomEvent Triggered when the user presses Search enter.
public	coral-select:hideitems: CustomEvent Triggered when the Select hides the UI used to select items.
public	coral-select:showitems: CustomEvent Triggered when the Select could accept external data to be loaded by the user.
public	coral-selectlist:change: CustomEvent Triggered before the SelectList selected item is changed on user interaction.
public	coral-selectlist:change: CustomEvent Triggered when the SelectList selected item has changed.
public	coral-selectlist:scrollbottom: CustomEvent Triggered when the user scrolls to near the bottom of the SelectList.
public	coral-shell-menubar-item:close: CustomEvent Triggered after the ShellMenuBarItem is closed with `hide()` or `instance.open = false`
public	coral-shell-menubar-item:open: CustomEvent Triggered after the ShellMenuBarItem is opened with `show()` or `instance.open = true`
public	coral-shell-orgswitcher:change: CustomEvent Triggered when the ShellOrgSwitcher selected organization has changed.
public	coral-sidenav:change: CustomEvent Triggered when SideNav selected item has changed.
public	coral-steplist:change: CustomEvent Triggered when the StepList selected Step has changed.
public	coral-table:beforecolumndrag: CustomEvent Triggered before a Table column is dragged.
public	coral-table:beforecolumnsort: CustomEvent Triggered before a Table column gets sorted by user interaction.
public	coral-table:beforeroworder: CustomEvent Triggered before a Table row is ordered.
public	coral-table:change: CustomEvent Triggered when the Table selection changed.
public	coral-table:columndrag: CustomEvent Triggered when a Table column is dragged.
public	coral-table:columnsort: CustomEvent Triggered when a Table column is sorted.
public	coral-table:rowchange: CustomEvent Triggered when a Table row selection changed.
public	coral-table:rowlock: CustomEvent Triggered when a {@linked Table} row is locked.
public	coral-table:roworder: CustomEvent Triggered when a Table row is ordered.
public	coral-table:rowunlock: CustomEvent Triggered when Table a row is locked.
public	coral-tablist:change: CustomEvent Triggered when the TabList selected item has changed.
public	coral-tabview:change: CustomEvent Triggered when the TabView selected tab panel item has changed.
public	coral-tree:change: CustomEvent Triggered when the Tree selection changed.
public	coral-tree:collapse: CustomEvent Triggered when a Tree item collapsed.
public	coral-tree:expand: CustomEvent Triggered when a Tree item expanded.
public	coral-wait:change: CustomEvent Triggered when the Wait value is changed.
public	coral-wizardview:change: CustomEvent Triggered when the WizardView selected step list item has changed.

Static Public

public AccordionVariantEnum: Object source

Enumeration for Accordion variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		Default look and feel.
QUIET	String		Not supported. Falls back to DEFAULT.
LARGE	String		Not supported. Falls back to DEFAULT.

public ActionBarContainerPositionEnum: Object source

Enumeration for ActionBarContainer positions.

Properties:

Name	Type	Attribute	Description
PRIMARY	String		Primary (left) ActionBar container.
SECONDARY	String		Secondary (right) ActionBar container.
INVALID	String		Invalid ActionBar container.

public AlertSizeEnum: Object source

Enumeration for Alert sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small alert, usually employed for single line alerts without headers.
LARGE	String		Not supported. Falls back to SMALL.

public AlertVariantEnum: Object source

Enumeration for Alert variants.

Properties:

Name	Type	Attribute	Description
ERROR	String		An alert with a warning icon to indicate that an error has occurred.
WARNING	String		An alert with a warning icon to warn the user of something important.
SUCCESS	String		An alert with a question mark icon to notify the user of a successful operation.
HELP	String		A neutral alert with a question icon to help the user with non-critical information.
INFO	String		An alert with an info icon to inform the user of non-critical information.

public AutocompleteMatchEnum: Object source

Enumeration for Autocomplete match options.

Properties:

Name	Type	Attribute	Description
STARTSWITH	String		Include only matches that start with the user provided value.
CONTAINS	String		Include only matches that contain the user provided value.

public AutocompleteSuggestion: Object source

A suggestion object.

Properties:

Name	Type	Attribute	Description
value	String		The form submission value to use when this suggestion is selected.
content	String	optional default: value	The content to disable in the suggestion dropdown.

public AutocompleteVariantEnum: Object source

Enumeration for Autocomplete variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default, gray Autocomplete.
QUIET	String		An Autocomplete with no border or background.

public BannerVariantEnum: Object source

Enumeration for Banner variants.

Properties:

Name	Type	Attribute	Description
ERROR	String		A banner to indicate that an error has occurred.
WARNING	String		A banner to warn the user of something important.
INFO	String		A banner to inform the user of non-critical information.

public BaseFieldGroupOrientationEnum: Object source

Enumeration for BaseFieldGroup orientations.

Properties:

Name	Type	Attribute	Description
HORIZONTAL	String		Horizontal default orientation.
VERTICAL	String		Vertical orientation.

public ButtonGroupSelectionModeEnum: Object source

Enumeration for ButtonGroup selection options.

Properties:

Name	Type	Attribute	Description
NONE	String		None is default, selection of buttons doesn't happen based on click.
SINGLE	String		Single selection mode, button group behaves like radio input elements.
MULTIPLE	String		Multiple selection mode, button group behaves like checkbox input elements.

public ButtonIconPositionEnum: Object source

Enumeration for BaseButton icon position options.

Properties:

Name	Type	Attribute	Description
RIGHT	String		Position should be right of the button label.
LEFT	String		Position should be left of the button label.

public ButtonIconSizeEnum: Object source

Enumeration for Button, AnchorButton icon sizes.

Properties:

Name	Type	Attribute	Description
EXTRA_EXTRA_SMALL	String		Extra extra small size icon, typically 9px size.
EXTRA_SMALL	String		Extra small size icon, typically 12px size.
SMALL	String		Small size icon, typically 18px size. This is the default size.
MEDIUM	String		Medium size icon, typically 24px size.

public ButtonSizeEnum: Object source

Enumeration for BaseButton sizes.

Properties:

Name	Type	Attribute	Description
MEDIUM	String		A medium button is the default, normal sized button.
LARGE	String		Not supported. Falls back to MEDIUM.

public ButtonVariantEnum: Object source

Enumeration for Button, AnchorButton variants.

Properties:

Name	Type	Attribute	Description
CTA	String		A button that is meant to grab the user's attention.
PRIMARY	String		A button that is meant to grab the user's attention.
QUIET	String		A quiet button that indicates that the button's action is the primary action.
SECONDARY	String		A button that indicates that the button's action is the secondary action.
QUIET_SECONDARY	String		A quiet secondary button.
ACTION	String		An action button.
QUIET_ACTION	String		A quiet action button.
MINIMAL	String		A quiet minimalistic button.
WARNING	String		A button that indicates that the button's action is dangerous.
QUIET_WARNING	String		A quiet warning button,
OVER_BACKGROUND	String		A button to be placed on top of colored background.
DEFAULT	String		The default button look and feel.

public CardVariantEnum: Object source

Enumeration for Card variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		Default card variant that shows the asset, overlay and content in their default positions.
QUIET	String		Quiet card variant that shows the asset, overlay and content in their default positions.
CONDENSED	String		Condensed card variant where the overlay is hidden and the content is shown over the image.
INVERTED	String		Condensed card variant where the overlay is hidden and the content is shown over the image with a dark style.
ASSET	String		Card variant where only the asset is shown.

public CharacterCountTargetEnum: Object source

Enumeration for CharacterCount targets.

Properties:

Name	Type	Attribute	Description
PREVIOUS	String		Relates the CharacterCount to the previous sibling.
NEXT	String		Relates the CharacterCount to the next sibling.

public ClockVariantEnum: Object source

Enumeration for Clock variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default, gray Clock.
QUIET	String		A Clock with no border or background.

public CoachMarkSizeEnum: Object source

Enumeration for CoachMark sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small sized coach mark.
MEDIUM	String		A default sized coach mark.

public CoachMarkVariantEnum: Object source

Enumeration for CoachMark variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		The default styled coach mark.
LIGHT	String		A styled coach mark for dark backgrounds.
DARK	String		A styled coach mark for light backgrounds.

public CollectionFilter(element: HTMLElement): Boolean: function source

Signature of the function called to determine if an element should be included in the Collection. If the function returns true for the given element it will be part of the collection, otherwise it will be excluded.

Params:

Name	Type	Attribute	Description
element	HTMLElement		The item to check whether it should be part of the collection.

Return:

Boolean

true if should be part of the collection, otherwise false.

public CollectionOnChange(addedNodes: Array<HTMLElement>, removedNodes: Array<HTMLElement>): function source

Signature of the function called when there is a change in the Collection. The items that where added and removed will be provided.

Params:

Name	Type	Attribute	Description
addedNodes	Array<HTMLElement>		An array that contains the items that were added to the collection.
removedNodes	Array<HTMLElement>		An array that contains the items that were removed from the collection.

public CollectionOnItemAdded(item: HTMLElement): function source

Signature of the function called when ever an item is added to the Collection.

Params:

Name	Type	Attribute	Description
item	HTMLElement		The item that was added to the collection.

public CollectionOnItemRemoved(item: HTMLElement): function source

Signature of the function called when ever an item is removed from the Collection.

Params:

Name	Type	Attribute	Description
item	HTMLElement		The item that was added to the collection.

public ColorInputAutoGenerateColorsEnum: Object source

Enumeration for ColorInput auto generated colors options.

Properties:

Name	Type	Attribute	Description
OFF	String		Disable auto generation.
SHADES	String		Automatically generate shades (darker colors) of all colors.
TINTS	String		Automatically generate tints (lighter colors) of all colors.

public ColorInputShowDefaultColorsEnum: Object source

Enumeration for ColorInput default colors display options.

Properties:

Name	Type	Attribute	Description
ON	String		Display default colors (default).
OFF	String		Hide default colors.

public ColorInputShowPropertiesEnum: Object source

Enumeration for ColorInput color properties display options.

Properties:

Name	Type	Attribute	Description
ON	String		Display color properties view (default).
OFF	String		Hide color properties view.

public ColorInputShowSwatchesEnum: Object source

Enumeration for ColorInput swatches display options.

Properties:

Name	Type	Attribute	Description
ON	String		Display swatches view (default).
OFF	String		Hide swatches view.

public ColorInputVariantEnum: Object source

Enumeration for ColorInput variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		Use ColorInput as a formfield (default).
SWATCH	String		Use a simple swatch as ColorInput.

public ColumnViewItemVariantEnum: Object source

Enumeration for ColumnViewItem variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		Default item variant. Contains no special decorations.
DRILLDOWN	String		An item with a right arrow indicating that the navigation will go one level down.

public ColumnViewSelectionModeEnum: Object source

Enumeration for ColumnView selection options.

Properties:

Name	Type	Attribute	Description
NONE	String		None is default, selection of items does not happen based on click.
SINGLE	String		Single selection mode, only one item per column can be selected.
MULTIPLE	String		Multiple selection mode, multiple items per column can be selected.

public CycleButtonDisplayModeEnum: Object source

Enumeration for CycleButton display options.

Properties:

Name	Type	Attribute	Description
ICON	String		Icon display mode.
TEXT	String		Text display mode.
ICON_TEXT	String		Icon and text display mode.

public CycleButtonItemDisplayModeEnum: Object source

Enum for {CycleButtonItem} display options.

Properties:

Name	Type	Attribute	Description
ICON	String		Icon display mode.
TEXT	String		Text display mode.
ICON_TEXT	String		Icon and text display mode.
INHERIT	String		Inherit display mode.

public DatepickerTypeEnum: Object source

Enumeration for Datepicker variants.

Properties:

Name	Type	Attribute	Description
DATE	String		The selection overlay contains only a calendar.
DATETIME	String		Provides both calendar and time controls in the selection overlay.
TIME	String		The selection overlay provides only time controls.

public DatepickerVariantEnum: Object source

Enum for Datepicker variant values.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default, gray Datepicker.
QUIET	String		A Datepicker with no border or background.

public DialogBackdropEnum: Object source

Enumeration for Dialog backdrops.

Properties:

Name	Type	Attribute	Description
NONE	String		No backdrop.
MODAL	String		A backdrop that hides the dialog when clicked.
STATIC	String		A backdrop that does not hide the dialog when clicked.

public DialogClosableEnum: Object source

Enumeration for Dialog closable options.

Properties:

Name	Type	Attribute	Description
ON	String		Show a close button on the dialog and close the dialog when clicked.
OFF	String		Do not show a close button. Elements with the `coral-close` attribute will still close the dialog.

public DialogInteractionEnum: Object source

Enumeration for Dialog keyboard interaction options.

Properties:

Name	Type	Attribute	Description
ON	String		Keyboard interaction is enabled.
OFF	String		Keyboard interaction is disabled.

public DialogVariantEnum: Object source

Enumeration for Dialog variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default dialog without header icon.
ERROR	String		A dialog with an error header and icon, indicating that an error has occurred.
WARNING	String		A dialog with a warning header and icon, notifying the user of something important.
SUCCESS	String		A dialog with a success header and icon, indicates to the user that an operation was successful.
HELP	String		A dialog with a question header and icon, provides the user with help.
INFO	String		A dialog with an info header and icon, informs the user of non-critical information.

public DragActionAxisEnum: Object source

Enumeration for DragAction axis restrictions.

Properties:

Name	Type	Attribute	Description
FREE	String		Allows vertically and horizontally dragging.
VERTICAL	String		Allows vertically dragging only.
HORIZONTAL	String		Allows horizontally dragging only.

public DrawerDirectionEnum: Object source

Enumeration for Drawer directions.

Properties:

Name	Type	Attribute	Description
DOWN	String		A drawer with a toggle button on the bottom.
UP	String		A drawer with a toggle button on top.

public FileUploadItemResponseTypeEnum: Object source

Enumeration for FileUploadItem response types.

Properties:

Name	Type	Attribute	Description
TEXT	String		String type.
ARRAY_BUFFER	String		Array buffer type.
BLOB	String		Blob type.
DOCUMENT	String		Document type.
JSON	String		JavaScript object, parsed from a JSON string returned by the server.

public FileUploadMethodEnum: Object source

Enumeration for FileUpload HTTP methods that can be used to upload files.

Properties:

Name	Type	Attribute	Description
POST	String		Send a POST request. Used when creating a resource.
PUT	String		Send a PUT request. Used when replacing a resource.
PATCH	String		Send a PATCH request. Used when partially updating a resource.

public I18nLocalesEnum: Object source

Enumeration for i18n locales.

Properties:

Name	Type	Attribute	Description
en	String		English (U.S.)
en-us	String		English (U.S.)
cs	String		Czech (Czechia)
cs-cz	String		Czech (Czechia)
da	String		Danish (Denmark)
da-dk	String		Danish (Denmark)
de	String		German (Germany)
de-de	String		German (Germany)
es	String		Spanish (Spain)
es-es	String		Spanish (Spain)
fi	String		Finnish (Finland)
fi-fi	String		Finnish (Finland)
fr	String		French (France)
fr-fr	String		French (France)
it	String		Italian (Italy)
it-it	String		Italian (Italy)
ja	String		Japanese (Japan)
ja-jp	String		Japanese (Japan)
ko	String		Korean (Korea)
ko-kr	String		Korean (Korea)
nb	String		Norwegian Bokmål (Norway)
nb-no	String		Norwegian Bokmål (Norway)
nl	String		Dutch (Netherlands)
nl-nl	String		Dutch (Netherlands)
pl	String		Polish (Poland)
pl-pl	String		Polish (Poland)
pt	String		Portuguese (Brazil)
pt-br	String		Portuguese (Brazil)
ru	String		Russian (Russia)
ru-ru	String		Russian (Russia)
sv	String		Swedish (Sweden)
sv-se	String		Swedish (Sweden)
tr	String		Turkish (Turkey)
tr-tr	String		Turkish (Turkey)
zh-cn	String		Simplified Chinese
zh-hans-cn	String		Simplified Chinese
zh-hans	String		Simplified Chinese
zh-tw	String		Traditional Chinese
zh-hant-tw	String		Traditional Chinese
zh-hant	String		Traditional Chinese

public IconAutoAriaLabelEnum: Object source

Enumeration for Icon autoAriaLabel value.

Properties:

Name	Type	Attribute	Description
ON	String		The aria-label attribute is automatically set based on the icon name.
OFF	String		The aria-label attribute is not set and has to be provided explicitly.

public IconSizeEnum: Object source

Enumeration for Icon sizes.

Properties:

Name	Type	Attribute	Description
EXTRA_EXTRA_SMALL	String		Extra extra small size icon, typically 9px size.
EXTRA_SMALL	String		Extra small size icon, typically 12px size.
SMALL	String		Small size icon, typically 18px size. This is the default size.
MEDIUM	String		Medium size icon, typically 24px size.
LARGE	String		Large icon, typically 36px size.
EXTRA_LARGE	String		Extra large icon, typically 48px size.
EXTRA_EXTRA_LARGE	String		Extra extra large icon, typically 72px size.

public ListInteractionEnum: Object source

Enumeration for BaseList interactions.

Properties:

Name	Type	Attribute	Description
ON	String		Keyboard interaction is enabled.
OFF	String		Keyboard interaction is disabled.

public MasonryAriaGridEnum: Object source

Enumeration values to enable/disable aria grid support for Masonry.

Properties:

Name	Type	Attribute	Description
ON	String		Turn on auto aria grid roles.
OFF	String		OFF is default. Turn off auto aria grid roles.

public MasonryLayoutsEnum: Object source

Enumeration for Masonry layouts.

Properties:

Name	Type	Attribute	Description
FIXED_CENTERED	String		A Layout with fixed width centered items.
FIXED_SPREAD	String		A layout with fixed width and evenly spread items.
VARIABLE	String		A layout with variable width items.
DASHBOARD	String		A layout with variable width items which are expanded in their height to fill gaps.

public MasonrySelectionModeEnum: Object source

Enumeration for Masonry selection options.

Properties:

Name	Type	Attribute	Description
NONE	String		None is default, selection of Masonry items doesn't happen based on click.
SINGLE	String		Single selection mode, Masonry behaves like radio input elements.
MULTIPLE	String		Multiple selection mode, Masonry behaves like checkbox input elements.

public OverlayAlignEnum: Object source

this typedef was deprecated.

Enumeration for Overlay alignment pairs.

Properties:

Name	Type	Attribute	Description
LEFT_TOP	String		Use the top of the left side as an anchor point.
LEFT_CENTER	String		Use the center of the left side as an anchor point.
LEFT_BOTTOM	String		Use the bottom of the left side as an anchor point.
CENTER_TOP	String		Use the center of the top side as an anchor point.
CENTER_CENTER	String		Use the center as an anchor point.
CENTER_BOTTOM	String		Use the center of the bottom side as an anchor point.
RIGHT_TOP	String		Use the top of the right side as an anchor point.
RIGHT_CENTER	String		Use the center of the right side as an anchor point.
RIGHT_BOTTOM	String		Use the bottom of the right side as an anchor point.

public OverlayCollisionEnum: Object source

Enumeration for Overlay collision detection strategies.

Properties:

Name	Type	Attribute	Description
FLIP	String		Flips the element to the opposite side of the target and the collision detection is run again to see if it will fit. Whichever side allows more of the element to be visible will be used.
FIT	String		Shift the element away from the edge of the window.
FLIP_FIT	String		Deprecated. First applies the flip logic, placing the element on whichever side allows more of the element to be visible. Then the fit logic is applied to ensure as much of the element is visible as possible.
NONE	String		Does not apply any collision detection.

public OverlayFadeTime: Number source

The time it should take for BaseOverlay to fade in milliseconds. Important: This should be greater than or equal to the CSS transition time.

public OverlayFocusOnShowEnum: Object source

Enumeration for BaseOverlay focus behavior options.

Properties:

Name	Type	Attribute	Description
ON	String		When the overlay is opened, it will be focused.
OFF	String		The overlay will not focus itself when opened.

public OverlayInteractionEnum: Object source

Enumeration for Overlay interaction values.

Properties:

Name	Type	Attribute	Description
ON	String		Keyboard interaction is enabled.
OFF	String		Keyboard interaction is disabled.

public OverlayPlacementEnum: Object source

Enumeration for Overlay placement values.

Properties:

Name	Type	Attribute	Description
LEFT	String		An overlay anchored to the left of the target.
RIGHT	String		An overlay anchored to the right of the target.
BOTTOM	String		An overlay anchored at the bottom the target.
TOP	String		An overlay anchored at the top target.

public OverlayReturnFocusEnum: Object source

Enumeration for BaseOverlay return focus options.

Properties:

Name	Type	Attribute	Description
ON	String		When the overlay is closed, the element that was focused before the it was shown will be focused again.
OFF	String		Nothing will be focused when the overlay is closed.

public OverlayScrollOnFocusEnum: Object source

Enumeration for BaseOverlay scroll focus options.

Properties:

Name	Type	Attribute	Description
ON	String		Scroll the document to bring the newly-focused element into view.
OFF	String		Document will not scroll on focus.

public OverlayTargetEnum: Object source

Enumeration for Overlay anchored overlay targets.

Properties:

Name	Type	Attribute	Description
PREVIOUS	String		Use the previous sibling element in the DOM.
NEXT	String		Use the next sibling element in the DOM.

public OverlayTrapFocusEnum: Object source

Enumeration for BaseOverlay trap options.

Properties:

Name	Type	Attribute	Description
ON	String		Focus is trapped such that the use cannot focus outside of the overlay.
OFF	String		The user can focus outside the overlay as normal.

public PopoverClosableEnum: Object source

Enumeration for Popover closable state.

Properties:

Name	Type	Attribute	Description
ON	String		Show a close button on the popover and close the popover when clicked.
OFF	String		Do not show a close button. Elements with the `coral-close` attributes will still close the popover.

public PopoverVariantEnum: Object source

Enumeration for Popover variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default popover without header icon.
ERROR	String		A popover with an error header and icon, indicating that an error has occurred.
WARNING	String		A popover with a warning header and icon, notifying the user of something important.
SUCCESS	String		A popover with a success header and icon, indicates to the user that an operation was successful.
HELP	String		A popover with a question header and icon, provides the user with help.
INFO	String		A popover with an info header and icon, informs the user of non-critical information.

public ProgressLabelPositionEnum: Object source

Enumeration for Progress label positions.

Properties:

Name	Type	Attribute	Description
LEFT	String		Show the label to the left of the bar.
SIDE	String		Show the label to the side of the bar.
RIGHT	String		Not supported. Falls back to LEFT.
BOTTOM	String		Not supported. Falls back to LEFT.

public ProgressSizeEnum: Object source

Enumeration for Progress sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small progress bar.
MEDIUM	String		A default medium progress bar.
LARGE	String		Not supported. Falls back to MEDIUM.

public QuickActionsInteractionEnum: Object source

Enumeration for QuickActions interaction options.

Properties:

Name	Type	Attribute	Description
ON	String		Show when the target is hovered or focused and hide when the mouse is moved out or focus is lost.
OFF	String		Do not show or hide automatically.

public QuickActionsItemTypeEnum: Object source

Enumeration for QuickActionsItem type values.

Properties:

Name	Type	Attribute	Description
BUTTON	String		Default button type
ANCHOR	String		Anchor button type

public QuickActionsPlacementEnum: Object source

Enumeration for QuickActions placement options.

Properties:

Name	Type	Attribute	Description
TOP	String		QuickActions inset to the top of the target.
CENTER	String		QuickActions inset to the center of the target.
BOTTOM	String		QuickActions inset to the bottom the target.

public QuickActionsTargetEnum: Object source

Enumeration for QuickActions anchored overlay target options.

Properties:

Name	Type	Attribute	Description
PARENT	String		Use the parent element in the DOM.
PREVIOUS	String		Use the previous sibling element in the DOM.
NEXT	String		Use the next sibling element in the DOM.

public RadioGroupOrientationEnum: Object source

Enumeration for RadioGroup orientations.

Properties:

Name	Type	Attribute	Description
HORIZONTAL	String		Horizontal default orientation.
VERTICAL	String		Vertical orientation.
LABELS_BELOW	String		Renders labels below items.

public SearchVariantEnum: Object source

Enumeration for Search variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default, gray search input.
QUIET	String		A search with no border, no background, no glow.

public SelectVariantEnum: Object source

Enumeration for Select variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default, gray Select.
QUIET	String		A Select with no border or background.

public ShellHelpResult: Object source

A search result object.

Properties:

Name	Type	Attribute	Description
title	String		The title of the search result.
href	String		The URL of the search result.
target	String		This property specifies where to display the search result. Use this property only if the href property is present.
tags	Array<String>		A set of tags associated with the search result.

public ShellMenuBarItemHasPopupRoleEnum: Object source

Enumeration for valid aria-haspopup values.

Properties:

Name	Type	Attribute	Description
MENU	String		ShellMenuBarItem opens a menu.
LISTBOX	String		ShellMenuBarItem opens a list box.
TREE	String		ShellMenuBarItem opens a tree.
GRID	String		ShellMenuBarItem opens a grid.
DIALOG	String		ShellMenuBarItem opens a dialog.
DEFAULT	Null		Defaults to null.

public ShellMenuBarItemIconVariantEnum: Object source

Enumeration for ShellMenuBarItem icon variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default menubar item.
CIRCLE	String		A round image as menubar item.

public ShellUserAvatarEnum: Object source

Enumeration for ShellUser avatar options. Avatar assets should use one of those provided, when no asset is set

Properties:

Name	Type	Attribute	Description
DEFAULT	String		Default avatar, show user icon from icon font.

public SideNavVariantEnum: Object source

Enumeration for SideNav variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default sidenav.
MULTI_LEVEL	String		A sidenav with multiple levels of indentation.

public SliderOrientationEnum: Object source

Enumeration for Slider orientations.

Properties:

Name	Type	Attribute	Description
HORIZONTAL	String		Horizontal slider.
VERTICAL	String		Not supported. Falls back to HORIZONTAL.

public SplitButtonVariantEnum: Object source

Enumeration for SplitButton variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		The default button look and feel.
CTA	String		A button that is meant to grab the user's attention.
SECONDARY	String		A button that indicates that the button's action is the secondary action.

public StatusColorEnum: Object source

Enumeration for Status colors.

Properties:

Name	Type	Attribute	Description
DEFAULT	String
CELERY	String
YELLOW	String
FUCHSIA	String
INDIGO	String
SEA_FOAM	String
CHARTREUSE	String
MAGENTA	String
PURPLE	String

public StatusVariantEnum: Object source

Enumeration for Status variants.

Properties:

Name	Type	Attribute	Description
NEUTRAL	String		A default semantic neutral status.
WARNING	String		A notice semantic status.
SUCCESS	String		A positive semantic status.
ERROR	String		A negative semantic status.
INFO	String		An informative semantic status.

public StepListInteractionEnum: Object source

Enumeration for StepList interaction options.

Properties:

Name	Type	Attribute	Description
ON	String		Steps can be clicked to visit them.
OFF	String		Steps cannot be clicked.

TODO:

support "click only past steps" mode

public StepListSizeEnum: Object source

Enumeration for StepList sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small-sized StepList.
LARGE	String		A large-sized StepList.

public TabListOrientationEnum: Object source

Enumeration for TabList orientations.

Properties:

Name	Type	Attribute	Description
HORIZONTAL	String		Horizontal TabList, this is the default value.
VERTICAL	String		Vertical TabList.

public TabListSizeEnum: Object source

Enumeration for TabList sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small-sized tablist.
MEDIUM	String		A medium-sized tablist. This is the default.
LARGE	String		A large-sized tablist.

public TabViewOrientationEnum: Object source

Enumeration for TabView orientations.

Properties:

Name	Type	Attribute	Description
HORIZONTAL	String		Tabs on top of the panels. This is the default.
VERTICAL	String		Tabs are rendered on the side and match the height of the panels.

public TableColumnAlignmentEnum: Object source

Enumeration for TableColumn alignment options.

Properties:

Name	Type	Attribute	Description
LEFT	String		Left alignment.
CENTER	String		Center alignment.
RIGHT	String		Right alignment.

public TableColumnSortableDirectionEnum: Object source

Enumeration for TableColumn sortable direction options.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		Default. No sorting applied.
ASCENDING	String		Ascending sort.
DESCENDING	String		Descending sort.

public TableColumnSortableTypeEnum: Object source

Enumeration for TableColumn sortable type options.

Properties:

Name	Type	Attribute	Description
ALPHANUMERIC	String		Alphanumeric type. If sorting is based on TableCell#value, use {String}.
NUMBER	String		Number type. If sorting is based on TableCell#value, use {Number}.
DATE	String		Date type. If sorting is based on TableCell#value, use {Date} in milliseconds.
CUSTOM	String		Custom type. Sorting is based on user defined sorting.

public TableSectionDividerEnum: Object source

Enumeration for TableHead, TableBody and TableFoot divider values.

Properties:

Name	Type	Attribute	Description
NONE	String		No divider.
ROW	String		Row divider.
COLUMN	String		Column divider.
CELL	String		Row and Column divider.

public TableVariantEnum: Object source

Enumeration for Table variants

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default table.
QUIET	String		A quiet table with transparent borders and background.
LIST	String		Not supported. Falls back to DEFAULT.

public TagColorEnum: Object source

Enumeration for Tag colors.

Properties:

Name	Type	Attribute	Description
DEFAULT	String
GREY	String
BLUE	String
RED	String
ORANGE	String
GREEN	String
YELLOW	String
SEA_FOAM	String
FUCHSIA	String
LIGHT_BLUE	String		Not supported. Falls back to BLUE.
PERIWINKLE	String		Not supported. Falls back to BLUE.
CYAN	String		Not supported. Falls back to BLUE.
PLUM	String		Not supported. Falls back to RED.
MAGENTA	String		Not supported. Falls back to RED.
TANGERINE	String		Not supported. Falls back to ORANGE.
CHARTREUSE	String		Not supported. Falls back to GREEN.
KELLY_GREEN	String		Not supported. Falls back to GREEN.

public TagSizeEnum: Object source

Enumeration for Tag sizes. Only colored tags can have different sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small sized tag.
MEDIUM	String		A default sized tag.
LARGE	String		A large sized tag.

public TextareaVariantEnum: Object source

Enumeration for Textarea variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default textarea.
QUIET	String		A textarea with no border or background.

public TextfieldVariantEnum: Object source

Enumeration for Textfield variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default textfield.
QUIET	String		A textfield with no border or background.

public ToastPlacementEnum: Object source

Enumeration for Toast placement values.

Properties:

Name	Type	Attribute	Description
LEFT	String		A toast anchored to the bottom left of screen.
CENTER	String		A toast anchored to the bottom center of screen.
RIGHT	String		A toast anchored to the bottom right of screen.

public ToastVariantEnum: Object source

Enumeration for Toast variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A neutral toast.
ERROR	String		A toast to notify that an error has occurred or to warn the user of something important.
SUCCESS	String		A toast to notify the user of a successful operation.
INFO	String		A toast to notify the user of non-critical information.

public TooltipVariantEnum: Object source

Enumeration for Tooltip variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		A default tooltip that provides additional information.
INFO	String		A tooltip that informs the user of non-critical information.
SUCCESS	String		A tooltip that indicates an operation was successful.
ERROR	String		A tooltip that indicates an error has occurred.
WARNING	String		Not supported. Falls back to DEFAULT.
INSPECT	String		Not supported. Falls back to DEFAULT.

public TrackingEnum: Object source

Enumeration representing the tracking options.

Properties:

Name	Type	Attribute	Description
ON	String		Enables tracking of the component interactions.
OFF	String		Disables tracking of the component interactions.

public TreeItemVariantEnum: Object source

Enumeration for TreeItem variants.

Properties:

Name	Type	Attribute	Description
DRILLDOWN	String		Default variant with icon to expand/collapse subtree.
LEAF	String		Variant for leaf items. Icon to expand/collapse subtree is hidden.

public WaitSizeEnum: Object source

Enumeration for Wait sizes.

Properties:

Name	Type	Attribute	Description
SMALL	String		A small wait indicator.
MEDIUM	String		A medium wait indicator. This is the default size.
LARGE	String		A large wait indicator.

public WaitVariantEnum: Object source

Enumeration for Wait variants.

Properties:

Name	Type	Attribute	Description
DEFAULT	String		The default variant.
DOTS	String		Not supported. Falls back to DEFAULT.

public coral-accordion:change: CustomEvent source

Triggered when Accordion selected item has changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	AccordionItem		The prior selected item(s).
detail.selection	AccordionItem		The newly selected item(s).

public coral-autocomplete:hidesuggestions: CustomEvent source

Triggered when the Autocomplete hides the suggestions. This is typically used to cancel a load request because the suggestions will not be shown anymore.

public coral-autocomplete:showsuggestions: CustomEvent source

Triggered when the Autocomplete could accept external data to be loaded by the user. If preventDefault() is called, then a loading indicator will be shown. Autocomplete#loading should be set to false to indicate that the data has been successfully loaded.

Properties:

Name	Type	Attribute	Description
detail.value	String		The user input.

public coral-collection:add: CustomEvent source

Triggered when an item is added to the Collection. Collection events are not synchronous so the DOM may reflect a different reality although every addition or removal will be reported.

Properties:

Name	Type	Attribute	Description
detail.item	HTMLElement		The item that was added.

public coral-collection:remove: CustomEvent source

Triggered when an item is removed from a Collection. Collection events are not synchronous so the DOM may reflect a different reality although every addition or removal will be reported.

Properties:

Name	Type	Attribute	Description
detail.item	HTMLElement		The item that was removed.

public coral-columnview:activeitemchange: CustomEvent source

Triggered when the active item of the ColumnViewColumn changes.

Properties:

Name	Type	Attribute	Description
detail.column	ColumnViewColumn		The column whose active item has changed.
detail.activeItem	ColumnViewItem		The currently active item of the column.
detail.oldActiveItem	ColumnViewItem		The item of the column that was active before.

public coral-columnview:change: CustomEvent source

Triggered when the selection inside the ColumnViewColumn changes. In case both the selection and the active item change, the coral-columnview:activeitemchange will be triggered first.

Properties:

Name	Type	Attribute	Description
detail.column	ColumnViewColumn		The column whose selection changed.
detail.selection	ColumnViewItem \| Array<ColumnViewItem>		The new selection of the Column.
detail.oldSelection	ColumnViewItem \| Array<ColumnViewItem>		The old selection of the Column.

public coral-columnview:loaditems: CustomEvent source

Triggered when additional items can be loaded into the ColumnView. This will happen when the current column can still hold more items, when the user scrolls down the current column or when a new column needs to be loaded. If preventDefault() is called, then a loading indicator will be shown. ColumnViewColumn#loading should be set to false to indicate that the data has been successfully loaded.

Properties:

Name	Type	Attribute	Description
detail.column	ColumnViewColumn		The column that is requesting more items. While doing pagination, it will become the target of the loaded items.
detail.start	Number		Indicates the current amount of items in the `column` to do pagination. If `item` is available, start will be 0 to denote that the column should be loaded from the start.
detail.item	ColumnViewItem		The item that initialized the load. If item is provided, it means that a new column needs to be added after the load is performed. In this scenario, `column` will be refer to the column that holds the item.

public coral-columnview:navigate: CustomEvent source

Triggered when the ColumnView navigation is complete and the new columns are ready.

Properties:

Name	Type	Attribute	Description
detail.column	ColumnViewColumn		The last Column of the ColumnView that is used to determine the path. If the navigate was triggered because a new ColumnViewColumn was added, then it will match that column. In case the path was reduced, the column will match the last column.
detail.activeItem	ColumnViewItem		The currently active item of the ColumnView.

public coral-cyclebutton:change: CustomEvent source

Triggered when the CycleButton selected item has changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	CycleButtonItem		The prior selected item(s).
detail.selection	CycleButtonItem		The newly selected item(s).

public coral-dragaction:drag: CustomEvent source

Triggered when the DragAction#dragElement is being dragged.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-dragaction:dragend: CustomEvent source

Triggered when the DragAction#dragElement stops to be dragged.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-dragaction:dragendonkey: CustomEvent source

Triggered when the DragAction#dragElement is dropped on key.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element

public coral-dragaction:dragenter: CustomEvent source

Triggered when the DragAction#dragElement enters a drop element.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
dropElement	HTMLElement		The drop element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-dragaction:dragleave: CustomEvent source

Triggered when the DragAction#dragElement leaves a drop element.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
dropElement	HTMLElement		The drop element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-dragaction:dragonkeyfocusout: CustomEvent source

Triggered when the DragAction#dragElement is losing focus.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element

public coral-dragaction:dragonkeyspace: CustomEvent source

Triggered when the DragAction#dragElement is selected to be dragged.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element

public coral-dragaction:dragover: CustomEvent source

Triggered when the DragAction#dragElement is over a drop element.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
dropElement	HTMLElement		The drop element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-dragaction:dragoveronkeyarrowdown: CustomEvent source

Triggered when the DragAction#dragElement is moved on arrow down pressed.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element

public coral-dragaction:dragoveronkeyarrowup: CustomEvent source

Triggered when the DragAction#dragElement is moved on arrow up pressed.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element

public coral-dragaction:dragstart: CustomEvent source

Triggered when the DragAction#dragElement starts to be dragged.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-dragaction:drop: CustomEvent source

Triggered when the DragAction#dragElement is dropped on a drop element.

Properties:

Name	Type	Attribute	Description
dragElement	HTMLElement		The dragged element
dropElement	HTMLElement		The drop element
pageX	Number		The mouse position relative to the left edge of the document.
pageY	Number		The mouse position relative to the top edge of the document.

public coral-drawer:close: CustomEvent source

Triggered when the Drawer is closed.

public coral-drawer:open: CustomEvent source

Triggered when the Drawer is opened.

public coral-masonry:change: CustomEvent source

Triggered when Masonry selected item has changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	MasonryItem		The prior selected item(s).
detail.selection	MasonryItem		The newly selected item(s).

public coral-masonry:order: CustomEvent source

Triggered when a Masonry item is reordered.

Properties:

Name	Type	Attribute	Description
detail.item	MasonryItem		The reordered item
detail.oldBefore	MasonryItem	nullable: true	The previous item before the reordering.
detail.before	MasonryItem	nullable: true	The previous item after the reordering.

public coral-multifield:beforeitemorder: CustomEvent source

Triggered when the Multifield item are reordered.

Properties:

Name	Type	Attribute	Description
detail.item	MultifieldItem		The item to be ordered.
detail.oldBefore	MultifieldItem		Ordered item next sibling before the swap. If `null`, the item was the last item.
detail.before	MultifieldItem		Ordered item will be inserted before this sibling item. If `null`, the item is inserted at the end.

public coral-multifield:itemorder: CustomEvent source

Triggered when the Multifield item are reordered.

Properties:

Name	Type	Attribute	Description
detail.item	MultifieldItem		The ordered item.
detail.oldBefore	MultifieldItem		Ordered item next sibling before the swap. If `null`, the item was the last item.
detail.before	MultifieldItem		Ordered item was inserted before this sibling item. If `null`, the item was inserted at the end.

public coral-overlay:beforeclose: CustomEvent source

Triggered before the BaseOverlay is closed with hide() or instance.open = false.

Properties:

Name	Type	Attribute	Description
preventDefault	function		Call to stop the overlay from closing.

public coral-overlay:beforeopen: CustomEvent source

Triggered before the BaseOverlay is opened with show() or instance.open = true.

Properties:

Name	Type	Attribute	Description
preventDefault	function		Call to stop the overlay from opening.

public coral-overlay:close: CustomEvent source

Triggered after the BaseOverlay is closed with hide() or instance.open = false

public coral-overlay:open: CustomEvent source

Triggered after the BaseOverlay is opened with show() or instance.open = true

public coral-overlay:positioned: CustomEvent source

Triggered after the Overlay is positioned.

public coral-panelstack:change: CustomEvent source

Triggered when PanelStack selected panel has changed.

Properties:

Name	Type	Attribute	Description
detail.selection	Panel		The new selected panel.
detail.oldSelection	Panel		The prior selected panel.

public coral-progress:change: CustomEvent source

Triggered when the Progress value is changed.

public coral-search:clear: CustomEvent source

Triggered when the Search is cleared.

public coral-search:input: CustomEvent source

Triggered when Search input is given.

public coral-search:submit: CustomEvent source

Triggered when the user presses Search enter.

public coral-select:hideitems: CustomEvent source

Triggered when the Select hides the UI used to select items. This is typically used to cancel a load request because the items will not be shown anymore.

public coral-select:showitems: CustomEvent source

Triggered when the Select could accept external data to be loaded by the user. If preventDefault() is called, then a loading indicator will be shown. Select#loading should be set to false to indicate that the data has been successfully loaded.

Properties:

Name	Type	Attribute	Description
detail.start	Number		The count of existing items, which is the index where new items should start.

public coral-selectlist:change: CustomEvent source

Triggered before the SelectList selected item is changed on user interaction. Can be used to cancel selection.

Properties:

Name	Type	Attribute	Description
event.detail.item	SelectListItem		The selected item.

public coral-selectlist:change: CustomEvent source

Triggered when the SelectList selected item has changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	SelectListItem		The prior selected item(s).
detail.selection	SelectListItem		The newly selected item(s).

public coral-selectlist:scrollbottom: CustomEvent source

Triggered when the user scrolls to near the bottom of the SelectList. This can be useful for when additional items can be loaded asynchronously (i.e., infinite scrolling).

public coral-shell-menubar-item:close: CustomEvent source

Triggered after the ShellMenuBarItem is closed with hide() or instance.open = false

public coral-shell-menubar-item:open: CustomEvent source

Triggered after the ShellMenuBarItem is opened with show() or instance.open = true

public coral-shell-orgswitcher:change: CustomEvent source

Triggered when the ShellOrgSwitcher selected organization has changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	HTMLElement		The prior selected organization item.
detail.selection	HTMLElement		The newly selected organization item.

public coral-sidenav:change: CustomEvent source

Triggered when SideNav selected item has changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	SideNavItem		The prior selected item.
detail.selection	SideNavItem		The newly selected item.

public coral-steplist:change: CustomEvent source

Triggered when the StepList selected Step has changed.

Properties:

Name	Type	Attribute	Description
detail.selection	Step		The newly selected Step.
detail.oldSelection	Step		The previously selected Step.

public coral-table:beforecolumndrag: CustomEvent source

Triggered before a Table column is dragged. Can be used to cancel column dragging.

Properties:

Name	Type	Attribute	Description
detail.column	TableColumn		The dragged column.
detail.before	TableColumn		The column will be inserted before this sibling column. If `null`, the column is inserted at the end.

public coral-table:beforecolumnsort: CustomEvent source

Triggered before a Table column gets sorted by user interaction. Can be used to cancel column sorting and define custom sorting.

Properties:

Name	Type	Attribute	Description
detail.column	TableColumn		The column to be sorted.
detail.direction	String		The requested sorting direction for the column.

public coral-table:beforeroworder: CustomEvent source

Triggered before a Table row is ordered. Can be used to cancel row ordering.

Properties:

Name	Type	Attribute	Description
detail.row	TableRow		The row to be ordered.
detail.before	TableRow		The row will be inserted before this sibling row. If `null`, the row is inserted at the end.

public coral-table:change: CustomEvent source

Triggered when the Table selection changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	Array<TableRow>		The old item selection. When Table#multiple, it includes an Array.
detail.selection	Array<TableRow>		The item selection. When Table#multiple, it includes an Array.

public coral-table:columndrag: CustomEvent source

Triggered when a Table column is dragged.

Properties:

Name	Type	Attribute	Description
detail.column	TableColumn		The dragged column.
detail.oldBefore	TableColumn		The column next sibling before the swap. If `null`, the column was the last item.
detail.before	TableColumn		The column is inserted before this sibling column. If `null`, the column is inserted at the end.

public coral-table:columnsort: CustomEvent source

Triggered when a Table column is sorted.

public coral-table:rowchange: CustomEvent source

Triggered when a Table row selection changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	Array<TableCell>		The old item selection. When TableRow#multiple, it includes an Array.
detail.selection	Array<TableCell>		The item selection. When Coral.Table.Row#multiple, it includes an Array.
detail.row	TableRow		The targeted row.

public coral-table:rowlock: CustomEvent source

Triggered when a {@linked Table} row is locked.

Properties:

Name	Type	Attribute	Description
detail.row	TableRow		The locked row.

public coral-table:roworder: CustomEvent source

Triggered when a Table row is ordered.

Properties:

Name	Type	Attribute	Description
detail.row	TableRow		The ordered row.
detail.oldBefore	TableRow		The row next sibling before the swap. If `null`, the row was the last item.

public coral-table:rowunlock: CustomEvent source

Triggered when Table a row is locked.

Properties:

Name	Type	Attribute	Description
detail.row	TableRow		The unlocked row.

public coral-tablist:change: CustomEvent source

Triggered when the TabList selected item has changed.

Properties:

Name	Type	Attribute	Description
event.detail.oldSelection	Tab		The prior selected item(s).
event.detail.selection	Tab		The newly selected item(s).

public coral-tabview:change: CustomEvent source

Triggered when the TabView selected tab panel item has changed.

Properties:

Name	Type	Attribute	Description
event.detail.selection	Tab		The new selected tab panel item.

public coral-tree:change: CustomEvent source

Triggered when the Tree selection changed.

Properties:

Name	Type	Attribute	Description
detail.oldSelection	Array<TreeItem>		The old selected item.
detail.selection	Array<TreeItem>		The selected items.

public coral-tree:collapse: CustomEvent source

Triggered when a Tree item collapsed.

Properties:

Name	Type	Attribute	Description
detail.item	TreeItem		The collapsed item.

public coral-tree:expand: CustomEvent source

Triggered when a Tree item expanded.

Properties:

Name	Type	Attribute	Description
detail.item	TreeItem		The expanded item.

public coral-wait:change: CustomEvent source

Triggered when the Wait value is changed.

public coral-wizardview:change: CustomEvent source

Triggered when the WizardView selected step list item has changed.

Properties:

Name	Type	Attribute	Description
event.detail.selection	Step		The new selected step list item.
event.detail.oldSelection	Step		The prior selected step list item.