Reference Source

References

coral-base-button/src/scripts

summary
public

F BaseButton(superClass: *): *

The base element for Button components

public

Enumeration for BaseButton icon position options.

public

Enumeration for Button, AnchorButton icon sizes.

public

Enumeration for BaseButton sizes.

public

Enumeration for Button, AnchorButton variants.

coral-base-component/src/scripts

summary
public

The base element for all Coral components

public

Enumeration representing the tracking options.

coral-base-fieldgroup/src/scripts

summary
public

The base element for FieldGroup components

public

Enumeration for BaseFieldGroup orientations.

coral-base-formfield/src/scripts

summary
public

The base element for Form Field components.

coral-base-labellable/src/scripts

summary
public

Accessibility helper for components with label and icon properties

coral-base-list/src/scripts

summary
public

The base element for List components

public

F BaseListItem(superClass: *): *

The base element for List Item components

public

Enumeration for BaseList interactions.

coral-base-overlay/src/scripts

summary
public

The base element for Overlay components

public

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

public

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

public

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

public

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

public

The time it should take for BaseOverlay to fade in milliseconds.

public

Enumeration for BaseOverlay focus behavior options.

public

Enumeration for BaseOverlay return focus options.

public

Enumeration for BaseOverlay scroll focus options.

public

Enumeration for BaseOverlay trap options.

coral-collection/src/scripts

summary
public

Collection provides a standardized way to manipulate items in a component.

public

Collection capable of handling non-nested items with a selected attribute.

public

Signature of the function called to determine if an element should be included in the Collection.

public

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

Signature of the function called when there is a change in the Collection.

public

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

public

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

public

Triggered when an item is added to the Collection.

public

Triggered when an item is removed from a Collection.

coral-component-accordion/src/scripts

summary
public

An Accordion component consisting of multiple collapsible items.

public

A Accordion item component

public

Accordion item's content component

public

Accordion item's label component

public

Triggered when Accordion selected item has changed.

public

Enumeration for Accordion variants.

coral-component-actionbar/src/scripts

summary
public

An ActionBar component containing arbitrary items.

public
this class was deprecated.

An ActionBar container component

public

The ActionBar container collection

public

An ActionBar item component

public

An ActionBar primary component

public

An ActionBar secondary component

public

The base element for action bar containers

public

Enumeration for ActionBarContainer positions.

coral-component-alert/src/scripts

summary
public

C Alert

An Alert component used as static indicators of an operation's result, or as messages to highlight information to the user. It does not include a close button by default, but you can add it manually by adding the coral-close attribute on an element contained by the Alert.

public

The Alert default content

public

The Alert footer content

public

The Alert header content

public

Enumeration for Alert sizes.

public

Enumeration for Alert variants.

coral-component-anchorbutton/src/scripts

summary
public

A Link component rendering as a button allowing us to style an anchor element that both looks and behaves like a button rather than a link.

public

The AnchorButton label content

coral-component-autocomplete/src/scripts

summary
public

An Autocomplete component that allows users to search and select from a list of options.

public

The Autocomplete Item

public

A suggestion object.

public

Triggered when the Autocomplete hides the suggestions.

public

Triggered when the Autocomplete could accept external data to be loaded by the user.

public

Enumeration for Autocomplete match options.

public

Enumeration for Autocomplete variants.

coral-component-banner/src/scripts

summary
public

C Banner

A Banner component

public

A Banner Content component

public

A Banner Header component

public

Enumeration for Banner variants.

coral-component-button/src/scripts

summary
public

C Button

A Button component containing text and/or an icon.

public

The Button label content

coral-component-buttongroup/src/scripts

summary
public

A ButtonGroup component that can be used as a selection form field.

public

Enumeration for ButtonGroup selection options.

coral-component-calendar/src/scripts

summary
public

A Calendar component that can be used as a date selection form field.

coral-component-card/src/scripts

summary
public

C Card

A Card component to display content in different variations.

public

A Card property component

public

The Card PropertyList component

public

The Card Asset

public

The Card Content

public

A Card context component

public

A Card description component

public

The Card Info

public

The Card Overlay

public

A Card Property Content component

public

A Card sub title component

public

A Card title component

public

Enumeration for Card variants.

coral-component-charactercount/src/scripts

summary
public

A CharacterCount component that indicates the remaining characters in a Textfield or Textarea.

public

Enumeration for CharacterCount targets.

coral-component-checkbox/src/scripts

summary
public

A Checkbox component to be used as a form field.

public

The Checkbox label

coral-component-checkboxgroup/src/scripts

summary
public

A CheckboxGroup component to group checkbox fields

coral-component-clock/src/scripts

summary
public

C Clock

A Clock component that can be used as a time selection form field.

public

Enumeration for Clock variants.

coral-component-coachmark/src/scripts

summary
public

A coach mark component to highlight UI elements on the page.

public

Enumeration for CoachMark sizes.

public

Enumeration for CoachMark variants.

coral-component-colorinput/src/scripts

summary
public

An abstract subview class that other subviews should extend.

public

C Color

Color is used to get a color in different color spaces, calculate tints and shades etc.

public

A ColorInput component than can be used as a form field to select from a list of color options.

public

A ColorInput Color properties component

public

A ColorInput Item component

public

A ColorInput Slider component

public

A ColorInput Swatch component

public

A ColorInput Swatches component

public

Enumeration for ColorInput auto generated colors options.

public

Enumeration for ColorInput default colors display options.

public

Enumeration for ColorInput color properties display options.

public

Enumeration for ColorInput swatches display options.

public

Enumeration for ColorInput variants.

coral-component-columnview/src/scripts

summary
public

A ColumnView component to display and allow users to browse and select items in a dynamic tree structure (e.g.

public

The ColumnView collection

public

A ColumnView Column component

public

A ColumnView Item component

public

A ColumnView Preview component

public

ColumnView's Column content component

public

ColumnView's Item content component

public

ColumnView's Item thumbnail component

public

ColumnView's preview asset component

public

ColumnView's preview content component

public

ColumnView's preview label component

public

ColumnView's preview separator component

public

ColumnView's preview value component

public

Triggered when the active item of the ColumnViewColumn changes.

public

Triggered when the selection inside the ColumnViewColumn changes.

public

Triggered when additional items can be loaded into the ColumnView.

public

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

public

Enumeration for ColumnViewItem variants.

public

Enumeration for ColumnView selection options.

coral-component-cyclebutton/src/scripts

summary
public

A CycleButton component is a simple multi-state toggle button that toggles between the possible items below a certain threshold, and shows them in a popover selector when above.

public

A CycleButton Action component

public

A CycleButton Item component

public

Triggered when the CycleButton selected item has changed.

public

Enumeration for CycleButton display options.

public

Enum for {CycleButtonItem} display options.

coral-component-datepicker/src/scripts

summary
public

A Datepicker component that can be used as a date and time selection form field.

public

Enumeration for Datepicker variants.

public

Enum for Datepicker variant values.

coral-component-dialog/src/scripts

summary
public

C Dialog

A Dialog component that supports various use cases with custom content.

public

The Dialog default content

public

The Dialog footer content

public

The Dialog header content

public

Enumeration for Dialog backdrops.

public

Enumeration for Dialog closable options.

public

Enumeration for Dialog keyboard interaction options.

public

Enumeration for Dialog variants.

coral-component-drawer/src/scripts

summary
public

C Drawer

A Drawer component to display content that can be opened and closed with a sliding animation.

public

Drawer content component

public

Triggered when the Drawer is closed.

public

Triggered when the Drawer is opened.

public

Enumeration for Drawer directions.

coral-component-fileupload/src/scripts

summary
public

A FileUpload component that manages the upload process of multiple files.

public

C FileUploadItem(file: File | HTMLElement)

A FileUpload item encapsulating file meta-data

public

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

public

Enumeration for FileUploadItem response types.

coral-component-icon/src/scripts

summary
public

C Icon

An Icon component.

public

F loadIcons(svgURL: *)

public
public

Copyright 2020 Adobe.

public
public

Enumeration for Icon autoAriaLabel value.

public

Enumeration for Icon sizes.

coral-component-list/src/scripts

summary
public

An AnchorList component that supports multi-line text, icons, and text wrapping with ellipsis.

public

An AnchorList item component

public

A ButtonList component that supports multi-line text, icons, and text wrapping with ellipsis.

public

An ButtonList item component

public

C List

A List component that supports multi-line text, icons, and text wrapping with ellipsis.

public

The List divider

public

A List item component

public

A SelectList component is a selectable list of items.

public

A SelectList group component

public

A SelectList item component

public

The List item content

public

The SelectList Item content

public

Triggered when the SelectList selected item has changed.

public

Triggered before the SelectList selected item is changed on user interaction.

public

Triggered when the user scrolls to near the bottom of the SelectList.

coral-component-masonry/src/scripts

summary
public

A Masonry Column layout

public

Layout with variable width items which are expanded in their height to fill gaps (which are common with colspan).

public

Layout with fixed width centered items.

public

Layout with fixed width and evenly spread items.

public

C MasonryLayout(masonry: *)

Base class for masonry layouts.

public

Layout with variable width items.

public

V Masonry: *

A Masonry component that allows to lay out items in a masonry grid.

public

A Masonry Item component

public

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

public

Enumeration for Masonry layouts.

public

Enumeration for Masonry selection options.

public

Triggered when Masonry selected item has changed.

public

Triggered when a Masonry item is reordered.

coral-component-multifield/src/scripts

summary
public

A Multifield component that enables adding, reordering, and removing multiple instances of a component.

public
public

A Multifield item component.

public

The Multifield item content

public

Triggered when the Multifield item are reordered.

public

Triggered when the Multifield item are reordered.

coral-component-numberinput/src/scripts

summary
public

A NumberInput component is a numeric control form field.

coral-component-overlay/src/scripts

summary
public

A generic Overlay component.

public

V Overlay: *

public

Triggered after the Overlay is positioned.

public
this typedef was deprecated.

Enumeration for Overlay alignment pairs.

public

Enumeration for Overlay collision detection strategies.

public

Enumeration for Overlay interaction values.

public

Enumeration for Overlay placement values.

public

Enumeration for Overlay anchored overlay targets.

coral-component-panelstack/src/scripts

summary
public

C Panel

A Panel component

public

A PanelStack component holding a collection of panels.

public

A PanelStack Item Content component

public

Triggered when PanelStack selected panel has changed.

coral-component-popover/src/scripts

summary
public

A Popover component for small overlay content.

public

The Popover separator

public

The Popover default content

public

The Popover footer content

public

The Popover header content

public

Enumeration for Popover closable state.

public

Enumeration for Popover variants.

coral-component-progress/src/scripts

summary
public

A Progress component to indicate progress of processes.

public

The Progress label content

public

Triggered when the Progress value is changed.

public

Enumeration for Progress label positions.

public

Enumeration for Progress sizes.

coral-component-quickactions/src/scripts

summary
public

A QuickActions component is an overlay component that reveals actions when interacting with a container.

public

A QuickActions item component

public

Enumeration for QuickActions interaction options.

public

Enumeration for QuickActions placement options.

public

Enumeration for QuickActions anchored overlay target options.

public

Enumeration for QuickActionsItem type values.

coral-component-radio/src/scripts

summary
public

C Radio

A Radio component to be used as a form field.

public

The Radio label

coral-component-radiogroup/src/scripts

summary
public

A RadioGroup component to group radio fields

public

Enumeration for RadioGroup orientations.

coral-component-search/src/scripts

summary
public

C Search

A Search component is a search styled form field.

public

Triggered when the Search is cleared.

public

Triggered when Search input is given.

public

Triggered when the user presses Search enter.

public

Enumeration for Search variants.

coral-component-select/src/scripts

summary
public

C Select

A Select component is a form field that allows users to select from a list of options.

public

A Select item component

public

Triggered when the Select hides the UI used to select items.

public

Triggered when the Select could accept external data to be loaded by the user.

public

Enumeration for Select variants.

coral-component-shell/src/scripts

summary
public

C Shell

The Shell base component to be used with its family for console like applications.

public

A Shell Header component

public

A Shell Help component

public

A Shell Help item component

public

A Shell Home Anchor component

public

A Shell Menu component

public

A Shell MenuBar component

public

A Shell MenuBar Item component

public

A Shell OrgSwitcher component

public

A Shell Organization component

public

A Shell SelectList Switcher component

public

A Shell SelectListSwitcherItem component

public

A Shell Solution component

public

A Shell Solution Switcher component

public

A Shell Solutions component

public

A Shell Sub organization component

public

A Shell User component

public

A Shell Workspace component

public

A Shell Workspaces component

public

Shell's content component

public
this function was deprecated.

Shell's help separator

public

Shell HomeAnchor's label component

public

Shell's OrgSwitcher footer component

public

Shell's Solution label component

public
this function was deprecated.

Shell's solution sub-cloud name

public

Shell's User content component

public

Shell's User footer component

public

Shell's User heading component

public

Shell's User name component

public

Shell's User subheading component

public

A search result object.

public

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

public

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

public

Enumeration for valid aria-haspopup values.

public

Enumeration for ShellMenuBarItem icon variants.

public

Triggered when the ShellOrgSwitcher selected organization has changed.

public

Enumeration for ShellUser avatar options.

coral-component-sidenav/src/scripts

summary
public

A Side Navigation component to navigate the entire content of a product or a section.

public

A SideNav Item component.

public

A SideNav Level component

public

The SideNav Heading

public

The SideNav Item Content

public

Triggered when SideNav selected item has changed.

public

Enumeration for SideNav variants.

coral-component-slider/src/scripts

summary
public

A Ranged Slider

public

A Slider component is a form field that can be used to set a number within a range.

public

The Slider item

public

Slider's content component

public

V Slider: *

public

Enumeration for Slider orientations.

coral-component-splitbutton/src/scripts

summary
public

A Split Button component composed of an action and a trigger AnchorButton or Button.

public

Enumeration for SplitButton variants.

coral-component-status/src/scripts

summary
public

C Status

A Status component to describe the condition of another entity.

public

The Status Label

public

Enumeration for Status colors.

public

Enumeration for Status variants.

coral-component-steplist/src/scripts

summary
public

C Step

A Step component

public

A StepList component that holds a collection of steps.

public

A Step Label

public

Triggered when the StepList selected Step has changed.

public

Enumeration for StepList interaction options.

public

Enumeration for StepList sizes.

coral-component-switch/src/scripts

summary
public

C Switch

A Switch component is a toggle form field similar to a Checkbox component.

public

The Switch label

coral-component-table/src/scripts

summary
public

The base element for table sections

public

C Table

A Table component is a container component to display and manipulate data in two dimensions.

public

A Table body component

public

A Table cell component

public

A Table column component

public

A Table foot component

public

A Table head component

public

A Table header cell component

public

A Table row component

public

The Table HeaderCell content

public

Triggered before a Table column is dragged.

public

Triggered before a Table column gets sorted by user interaction.

public

Triggered before a Table row is ordered.

public

Triggered when the Table selection changed.

public

Triggered when a Table column is dragged.

public

Triggered when a Table column is sorted.

public

Triggered when a Table row selection changed.

public

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

public

Triggered when a Table row is ordered.

public

Triggered when Table a row is locked.

public

Enumeration for Table variants

public

Enumeration for TableColumn sortable direction options.

public

Enumeration for TableColumn sortable type options.

public

Enumeration for TableColumn alignment options.

public

Enumeration for TableHead, TableBody and TableFoot divider values.

coral-component-tablist/src/scripts

summary
public

C Tab

A Tab component

public

A TabList component holds a collection of tabs.

public

Tab's label component

public

Triggered when the TabList selected item has changed.

public

Enumeration for TabList orientations.

public

Enumeration for TabList sizes.

coral-component-tabview/src/scripts

summary
public

A TabView component is the wrapping container used to create the typical Tabbed pattern.

public

Triggered when the TabView selected tab panel item has changed.

public

Enumeration for TabView orientations.

coral-component-taglist/src/scripts

summary
public

C Tag

A Tag component

public

A TagList component is a form field container to manipulate tags.

public

Tag's label component

public

Enumeration for Tag colors.

public

Enumeration for Tag sizes.

coral-component-textarea/src/scripts

summary
public

A Textarea component is the default multi-line text form field.

public

Enumeration for Textarea variants.

coral-component-textfield/src/scripts

summary
public

A Textfield component is the default single line text form field.

public

Enumeration for Textfield variants.

coral-component-toast/src/scripts

summary
public

C Toast

Toasts display brief temporary notifications.

public

The Toast default content

public

Enumeration for Toast placement values.

public

Enumeration for Toast variants.

coral-component-tooltip/src/scripts

summary
public

A Tooltip component that can be attached to any element and may be displayed immediately or on hovering the target element.

public

Tooltip's content component

public

Enumeration for Tooltip variants.

coral-component-tree/src/scripts

summary
public

C Tree

A Tree component is a container component to display collapsible content.

public

A Tree item component

public

Tree item's content component

public

Triggered when the Tree selection changed.

public

Triggered when a Tree item collapsed.

public

Triggered when a Tree item expanded.

public

Enumeration for TreeItem variants.

coral-component-wait/src/scripts

summary
public

C Wait

A Wait component to be used to indicate a process that is in-progress for an indefinite amount of time.

public

Triggered when the Wait value is changed.

public

Enumeration for Wait sizes.

public

Enumeration for Wait variants.

coral-component-wizardview/src/scripts

summary
public

A WizardView component is the wrapping container used to create the typical Wizard pattern.

public

Triggered when the WizardView selected step list item has changed.

coral-datetime/src/scripts

summary
public

The DateTime API is used as fallback to momentJS.

coral-dragaction/src/scripts

summary
public

C DragAction(dragElement: String | HTMLElement)

This a decorator which adds draggable functionality to elements.

public

Triggered when the DragAction#dragElement is being dragged.

public

Triggered when the DragAction#dragElement stops to be dragged.

public

Triggered when the DragAction#dragElement enters a drop element.

public

Triggered when the DragAction#dragElement leaves a drop element.

public

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

public

Triggered when the DragAction#dragElement starts to be dragged.

public

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

public

Enumeration for DragAction axis restrictions.

coral-utils/src/scripts

summary
public

Utility belt.

public

C Events

Events helper.

public

I18n service to get/set localized strings.

public

C Keys

Handle key combination events.

public

Signature function used to track the usage of Coral components.

public

Set of property value transformation functions.

public

Set of property value validation functions.

public
public
public

An i18n service.

public

Used to store i18n strings.

public

V keys: Keys

A key listener for global hotkeys is exposed for document eventing handling.

public
public
public
public

Enumeration for i18n locales.