configuration
ui
aria-label

 

The ui aria-label property defines the editor's ARIA label. The editor's ARIA label identifies the editor to screen readers and other assistive devices.

When this is not set, the default ARIA label is "Textbox.io Rich Text Editor - <id>" where <id> is the ID attribute of the element used to load the editor. When the editor fullscreen feature is used, this changes to "Textbox.io Fullscreen Rich Text Editor - <id>".

If no ID is available on the target element a random 6 digit number is used instead.

Example Configuration

In this example using default configuration, the ARIA label will be "Textbox.io Rich Text Editor - blog"

<div id="blog"></div>

<script type="text/javascript">
var editor = textboxio.replace('#blog');
</script>

In this example, a simple configuration object is created that specifies a custom ARIA Label.

The ARIA label will literally be "Post Body Text", none of the default label is included in this scenario.

var configUi = {
  ui: {
    'aria-label': 'Post Body Text'
  }
};
 
var editor = textboxio.replace('#targetId', configUi);