Element: <oj-button>

Slots

JET elements can have up to two types of child content:

• Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
• Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child. This is documented under the "Default" heading below.

Default

The default slot is the button's text label. The <oj-button> element accepts plain text or DOM nodes as children for the default slot. A default slot label is required for all buttons for accessibility purposes. The label can be hidden using the display attribute.

If a text node is provided it will be wrapped in a span.

Examples

Initialize the Button with child content specified:

<oj-button>
  <span>myValue</span>
</oj-button>

Initialize the Button with data-bound child content specified in a span:

<oj-button>
  <span data-bind='text: myText'></span>
</oj-button>

Initialize the Button with data-bound child content specified without a container element:

<oj-button>
  <!-- ko text: myText --><!--/ko-->
</oj-button>

contextMenu

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot.

The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc and demos of the individual components for details.

Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

endIcon

The endIcon slot is the button's end icon. The <oj-button> element accepts DOM nodes as children with the endIcon slot.

Example

Initialize the Button with child content specified for the endIcon:

<oj-button>
  <span>myValue</span>
  <span slot='endIcon' class='myIconClass'></span>
</oj-button>

startIcon

The startIcon slot is the button's start icon. The <oj-button> element accepts DOM nodes as children with the startIcon slot.

Example

Initialize the Button with child content specified for the startIcon:

<oj-button>
  <span slot='startIcon' class='myIconClass'></span>
  <span>myValue</span>
</oj-button>

Attributes

chroming :string

Indicates in what states the button has chrome (background and border).

The default chroming varies by theme and containership as follows:

• If the button is in a buttonset or toolbar, then the default chroming is the current chroming value of the nearest such container.
• Else, if $buttonChromingOptionDefault is set in the current theme as seen in the example below, then that value is the chroming default.
• Else, the default chroming is "full".

Once a value has been set on this button attribute, that value applies regardless of theme and containership.

Supported Values:

Name	Type	Description
"full"	string	In typical themes, full-chrome buttons always have chrome.
"half"	string	In typical themes, half-chrome buttons acquire chrome only in their hover, active, and selected states. Half-chroming is recommended for buttons in a toolbar. (This is the toolbar default in most themes.)
"outlined"	string	In typical themes, outlined buttons are similar to half-chrome buttons, but have a border in the default state.

Names

Item	Name
Property	chroming
Property change event	chromingChanged
Property change listener attribute (must be of type function)	on-chroming-changed

Examples

Initialize the Button with the chroming attribute specified:

<oj-button chroming='half'></oj-button>

Get or set the chroming property after initialization:

// getter
var chromingValue = myButton.chroming;

// setter
myButton.chroming = 'half';

Set the default in the theme (SCSS) :

$buttonChromingOptionDefault: half !default;

disabled :boolean

Disables the button if set to true.

After create time, the disabled state should be set via this API, not by setting the underlying DOM attribute.

Default Value:

• false

Names

Item	Name
Property	disabled
Property change event	disabledChanged
Property change listener attribute (must be of type function)	on-disabled-changed

Examples

Initialize the Button with the disabled attribute specified:

<oj-button disabled='true'></oj-button>

Get or set the disabled property after initialization:

// getter
var disabledValue = myButton.disabled;

// setter
myButton.disabled = true;

display :string

Whether to display both the label and icons ("all") or just the icons ("icons"). In the latter case, the label is displayed in a tooltip instead, unless a tooltip was already supplied at create time.

For accessibility, a JET Button must always have a label set via the default slot, even if it is icon-only.

Supported Values:

Name	Type	Description
"all"	string	Display both the label and icons.
"icons"	string	Display only the icons.

Default Value:

• "all"

Names

Item	Name
Property	display
Property change event	displayChanged
Property change listener attribute (must be of type function)	on-display-changed

Examples

Initialize the Button with the display attribute specified:

<oj-button display='icons'></oj-button>

Get or set the display property after initialization:

// getter
var displayValue = myButton.display;

// setter
myButton.display = 'icons';

translations :Object|null

A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

If the component does not contain any translatable resource, the default value of this attribute will be null. If not, an object containing all resources relevant to the component.

If this component has translations, their documentation immediately follows this doc entry.

Names

Item	Name
Property	translations
Property change event	translationsChanged
Property change listener attribute (must be of type function)	on-translations-changed

Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

Events

ojAction

Triggered when a button is clicked. This will be triggered by keyboard events as well as mouse/touch events.

To ensure keyboard accessibility, the only correct, supported way to react to the click of a button is to listen for this event. Click listeners and href navigation should not be used.

Since:

• 5.0.0

Examples

Specify an ojAction listener via the DOM attribute:

<oj-button on-oj-action='[[listener]]'></oj-button>

Specify an ojAction listener via the JavaScript property:

myButton.onOjAction = listener;

Add an ojAction listener via the addEventListener API:

myButton.addEventListener('ojAction', listener);

Methods

getProperty(property) → {any}

Retrieves a value for a property or a single subproperty for complex properties.

Parameters:

Name	Type	Description
property	string	The property name to get. Supports dot notation for subproperty access.

Since:

• 4.0.0

Returns:

Type

any

Example

Get a single subproperty of a complex property:

var subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');

refresh() → {void}

Refreshes the component.

Returns:

Type

void

setProperties(properties) → {void}

Performs a batch set of properties.

Parameters:

Name	Type	Description
properties	Object	An object containing the property and value pairs to set.

Since:

• 4.0.0

Returns:

Type

void

Example

Set a batch of properties:

myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});

setProperty(property, value) → {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.

Parameters:

Name	Type	Description
property	string	The property name to set. Supports dot notation for subproperty access.
value	any	The new value to set the property to.

Since:

• 4.0.0

Returns:

Type

void

Example

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");