> For the complete documentation index, see [llms.txt](https://docs.labii.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.labii.com/widgets/dashboard-widgets/office/ckeditor/ckeditor.md).

# CKEditor

## Specs

| Label                     | Value                         |
| ------------------------- | ----------------------------- |
| **Version**               | 0.1.0 (updated on 2023-07-24) |
| **Developer**             | Labii Inc.                    |
| **Type**                  | Dashboard                     |
| **Support Configuration** | Yes                           |

## Overview

The CKEditor dashboard widget provides a WYSIWYG rich text editor for composing and displaying formatted content on Labii dashboards. It enables laboratory teams to maintain dashboard notes, instructions, announcements, summaries, and formatted references in a familiar word-processor-style interface. This widget is useful for dashboards that combine operational metrics with written guidance, making key context visible next to shortcuts, reports, and monitoring widgets.

## Use Cases

* **Dashboard notes**: Add formatted instructions, reminders, or status notes to team dashboards.
* **Operational guidance**: Keep SOP summaries, shift notes, or workflow reminders visible alongside dashboard widgets.
* **Project communication**: Present project updates, milestones, or decision notes in a readable dashboard format.
* **Training dashboards**: Display onboarding notes, reference links, and formatted learning material for new users.
* **Executive summaries**: Combine rich text interpretation with dashboard reports and activity metrics.

## Configuration

### Initial Setup

{% stepper %}
{% step %}
Navigate to the dashboard where you want to add rich text content.
{% endstep %}

{% step %}
Click **Add Widget** and select **CKEditor** from the dashboard widget catalog.
{% endstep %}

{% step %}
Enter or paste the content you want to display on the dashboard.
{% endstep %}

{% step %}
Use the CKEditor toolbar to format headings, lists, links, tables, images, and other rich text elements as needed.
{% endstep %}

{% step %}
Click **Save** to publish the widget content to the dashboard.
{% endstep %}
{% endstepper %}

### Required Settings

* **Content**: The rich text body displayed by the widget.

### Optional Settings

* **Formatting**: Apply headings, emphasis, lists, alignment, tables, links, images, and other CKEditor-supported rich text formatting.
* **Layout placement**: Resize and position the widget on the dashboard so the content remains readable.

{% hint style="info" %}
For section-level rich text editing inside records, use the [section CKEditor documentation](/widgets/section-widgets/office/ckeditor/ckeditor-classic.md).
{% endhint %}

## Readonly View

Dashboard widgets are designed for quick visibility and interaction in dashboard context.

### Display Features

* **Formatted content**: Displays rich text with headings, lists, links, tables, and embedded media.
* **Dashboard context**: Keeps notes and written guidance visible beside related dashboard widgets.
* **Readable layout**: Presents content in the dashboard widget area without requiring users to open a record.
* **Persistent reference**: Maintains stable information for recurring team workflows and shared dashboards.

### Interactive Features

* **Open links**: Users can follow links included in the rich text content.
* **Review content**: Users can read formatted dashboard notes without entering edit mode.
* **Edit content**: Authorized users can update the widget content from the widget configuration or edit controls.

## Best Practices

### Content Design

* Keep dashboard text concise so users can scan it while working.
* Use headings and bullet points for instructions, status summaries, and reference notes.
* Place long procedures in dedicated documentation pages and link to them from the widget.
* Review shared dashboard content regularly so notes stay current.

### Dashboard Placement

* Place CKEditor near the widgets it explains or supports.
* Pair written summaries with report widgets to explain trends, exceptions, or action items.
* Reserve enough dashboard space for the text to remain readable on common screen sizes.