Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 2.6 KB

trix.md

File metadata and controls

88 lines (61 loc) · 2.6 KB
Raw

Trix

The trix component allows you to easily include a rich text editor in your form. Behind the scenes it makes use of the Trix library from Basecamp. The input is passed through to a form as a normal textarea input.

Installation

While the trix component works out-of-the-box when you've set the directives, we recommend that you install and compile its JavaScript libraries before you deploy to production:

Basic Usage

In its most basic usage, you use it as a self closing component and pass it a name:

<x-trix name="about" />

This will output the following HTML:

<div>
    <input name="about" id="about" value="" type="hidden">
    <trix-editor input="about" class="trix-content"></trix-editor>
</div>

Which will render the Trix editor. Of course, you can also specifically set a default value:

<x-trix name="about">My about text</x-trix>

This will output the following HTML:

<div>
    <input name="about" id="about" value="My about text" type="hidden">
    <trix-editor input="about" class="trix-content"></trix-editor>
</div>

Old Values

The trix component also supports old values that were set. For example, you might want to apply some validation in the backend, but also make sure the user doesn't lose their input data when you re-render the form with any validation errors. When re-rendering the form, the trix component will remember the old value:

<div>
    <input name="about" id="about" value="About me text" type="hidden">
    <trix-editor input="about" class="trix-content"></trix-editor>
</div>

Styling

You can use the trix-content class to style the content. To change this class use the styling attribute:

<x-trix name="about" styling="trix-styles" />

This will output the following HTML:

<div>
    <input name="about" id="about" value="" type="hidden">
    <trix-editor input="about" class="trix-styles"></trix-editor>
</div>

Custom Attributes

Any custom attributes will be placed on the encapsulating div element:

<x-trix name="about" class="border border-gray-500" />

This will output the following HTML:

<div class="border border-gray-500">
    <input name="about" id="about" value="" type="hidden">
    <trix-editor input="about" class="trix-content"></trix-editor>
</div>

The reason for this is that the Trix editor places its own classes, etc., on the editor itself so any attributes you place on it will get stripped out.