Wysiwyg
class Wysiwyg extends BaseFormField (View source)
Traits
Properties
| bool | $renderForBlocks | from RenderForBlocks | |
| protected bool | $translated | from IsTranslatable | |
| protected int|null | $maxlength | from HasMaxlength | |
| protected string|null | $placeholder | from HasPlaceholder | |
| protected string|null | $direction | from HasDirection | |
| protected string|null | $ref | from HasOnChange | |
| protected string|null | $onChange | from HasOnChange | |
| protected string|null | $onChangeAttribute | from HasOnChange | |
| bool | $hideCounter | ||
| bool | $editSource | ||
| array|null | $toolbarOptions | ||
| protected TiptapWrapper[] | $tiptapWrappers | ||
| array|null | $options | ||
| string | $type | ||
| bool | $limitHeight | ||
| bool | $syntax | ||
| string | $customTheme | ||
| array|null | $customOptions | ||
| array|null | $browserModules | ||
| array|null | $classList |
Methods
No description
No description
Set the name of the field, if no label is set yet, this method will also update that.
Set the label of the field, you can use twillTrans('') Laravel translatable strings here.
Marks the field as mandatory, however you still need to add validation rules.
No description
In render we dynamically build the constructor arguments.
Makes the field translatable.
Sets the placeholder of the field.
Hides the character counter.
Adds a edit source button.
Allows you to set custom toolbar options. This depends on the editor used.
Limits the height of the editor, otherwise grows infinitely.
Set a custom theme for the syntax highlighter.
Additional custom options.
No description
The browser module(s) that can be used to select existing content.
Details
RenderForBlocks
renderForBlocks(bool $renderForBlocks = true)
No description
bool
forBlocks()
No description
protected
__construct(string $component, string|null $name = null, string|null $label = null, string|null $note = null, bool|null $required = false, bool|null $disabled = false, mixed $default = null, mixed $connectedTo = null, array $mandatoryProperties = [])
No description
static BaseFormField
make()
No description
BaseFormField
name(string $name)
Set the name of the field, if no label is set yet, this method will also update that.
BaseFormField
default(mixed $default)
No description
BaseFormField
label(string $label)
Set the label of the field, you can use twillTrans('') Laravel translatable strings here.
BaseFormField
note(string $note)
Add a note to the field to display on the form.
BaseFormField
required(bool $required = true)
Marks the field as mandatory, however you still need to add validation rules.
BaseFormField
disabled(bool $disabled = true)
Marks the field as disabled.
There might be some fields not supporting this.
connectedTo(string $fieldName, mixed $fieldValues, array $options = [])
No description
View
render()
No description
protected array
getAdditionalConstructorArguments()
In render we dynamically build the constructor arguments.
In exceptional cases such as browser we have more conditionals and we can use this method to set those.
IsTranslatable
translatable(bool $translatable = true)
Makes the field translatable.
HasMaxlength
maxLength(string $maxlength)
Sets the max character length.
HasPlaceholder
placeholder(string $placeholder)
Sets the placeholder of the field.
HasDirection
direction(string $direction)
Sets the direction of the field.
HasOnChange
ref(string $ref)
The field to act on.
HasOnChange
onChange(string $onChange)
Javascript to execute on change.
HasOnChange
onChangeAttribute(string $onChangeAttribute)
Attribute to change.
Wysiwyg
hideCounter(bool $hideCounter = true)
Hides the character counter.
Wysiwyg
allowSource(bool $allowSource = true)
Adds a edit source button.
Wysiwyg
toolbarOptions(array $toolbarOptions)
Allows you to set custom toolbar options. This depends on the editor used.
Wysiwyg
options(array $options)
Allows you to set editor options. This depends on the editor used.
Wysiwyg
type(string $type)
The type of editor to use, defaults to quill, options are: tiptap
Wysiwyg
limitHeight(bool $limitHeight = true)
Limits the height of the editor, otherwise grows infinitely.
Wysiwyg
syntax(bool $syntax = true)
Enables syntax highlight.
Wysiwyg
customTheme(string $customTheme)
Set a custom theme for the syntax highlighter.
Wysiwyg
customOptions(array $customOptions)
Additional custom options.
Wysiwyg
addTiptapWrapper(TiptapWrapper $wrapper)
Add wrappers that can be used in the editor.
protected array
getToolbarOptions()
No description
Wysiwyg
browserModules(array|null $modules = null)
The browser module(s) that can be used to select existing content.
Wysiwyg
classList(array $list)
Assosiative array ['class' => 'Label'] of classes than will be available to editor in the form of checkboxes when creating new link in modal