-
Notifications
You must be signed in to change notification settings - Fork 90
Toolbar configuration #921
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
zoltanhosszu
wants to merge
4
commits into
main
Choose a base branch
from
toolbar-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| --- | ||
| title: Toolbar | ||
| layout: default | ||
| parent: Configuration | ||
| nav_order: 2 | ||
| --- | ||
|
|
||
| # Toolbar Customization | ||
|
|
||
| The toolbar layout is fully configurable through the `toolbar.items` array. Each entry defines a button, dropdown group, separator, or spacer. | ||
|
|
||
| ## Item types | ||
|
|
||
| | Entry | Description | | ||
| |-------|-------------| | ||
| | `"bold"` | A button name from the built-in registry (see below) | | ||
| | `{ name, icon, label, items }` | A dropdown group containing child items | | ||
| | `"|"` | A visual group separator — adds a border after the preceding item | | ||
| | `"~"` | A flexible spacer — pushes subsequent items to the right edge | | ||
|
|
||
| ## Default items | ||
|
|
||
| This is the default toolbar configuration: | ||
|
|
||
| ```js | ||
| toolbar: { | ||
| items: [ | ||
| "image", | ||
| "file", | ||
| "|", | ||
| "bold", | ||
| "italic", | ||
| { name: "format", icon: "heading", label: "Text formatting", items: [ | ||
| "paragraph", | ||
| "heading-large", | ||
| "heading-medium", | ||
| "heading-small", | ||
| "|", | ||
| "strikethrough", | ||
| "underline", | ||
| ] | ||
| }, | ||
| { name: "lists", icon: "ul", label: "Lists", items: [ | ||
| "unordered-list", | ||
| "ordered-list", | ||
| ] | ||
| }, | ||
| "highlight", | ||
| "link", | ||
| "quote", | ||
| "code", | ||
| "|", | ||
| "table", | ||
| "divider", | ||
| "~", | ||
| "undo", | ||
| "redo", | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Available items | ||
|
|
||
| | Name | Icon | Description | | ||
| |------|------|-------------| | ||
| | `image` | image | Upload images | | ||
| | `file` | attachment | Upload files | | ||
| | `bold` | bold | Bold formatting | | ||
| | `italic` | italic | Italic formatting | | ||
| | `paragraph` | paragraph | Normal text (typically inside a format dropdown) | | ||
| | `heading-large` | h2 | Large heading | | ||
| | `heading-medium` | h3 | Medium heading | | ||
| | `heading-small` | h4 | Small heading | | ||
| | `strikethrough` | strikethrough | Strikethrough text | | ||
| | `underline` | underline | Underline text | | ||
| | `unordered-list` | ul | Bullet list | | ||
| | `ordered-list` | ol | Numbered list | | ||
| | `highlight` | highlight | Color highlight picker | | ||
| | `link` | link | Insert/edit link | | ||
| | `quote` | quote | Block quote | | ||
| | `code` | code | Code block | | ||
| | `table` | table | Insert table | | ||
| | `divider` | hr | Horizontal divider | | ||
| | `undo` | undo | Undo | | ||
| | `redo` | redo | Redo | | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Minimal toolbar | ||
|
|
||
| ```js | ||
| Lexxy.configure({ | ||
| compact: { | ||
| toolbar: { | ||
| items: ["bold", "italic", "link", "|", "undo", "redo"] | ||
| } | ||
| } | ||
| }) | ||
| ``` | ||
|
|
||
| ```html | ||
| <lexxy-editor preset="compact"></lexxy-editor> | ||
| ``` | ||
|
|
||
| ### Without attachments | ||
|
|
||
| Omit `image` and `file` to remove upload buttons: | ||
|
|
||
| ```js | ||
| toolbar: { | ||
| items: [ | ||
| "bold", | ||
| "italic", | ||
| { name: "format", icon: "heading", label: "Text formatting", items: [ | ||
| "paragraph", "heading-large", "heading-medium", "heading-small", | ||
| "|", "strikethrough", "underline", | ||
| ] | ||
| }, | ||
| "link", | ||
| "quote", | ||
| "code", | ||
| "~", | ||
| "undo", | ||
| "redo", | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ### Custom dropdown groups | ||
|
|
||
| Create your own dropdown groupings: | ||
|
|
||
| ```js | ||
| toolbar: { | ||
| items: [ | ||
| "bold", | ||
| "italic", | ||
| { name: "insert", icon: "table", label: "Insert", items: [ | ||
| "table", | ||
| "divider", | ||
| "code", | ||
| "quote", | ||
| ] | ||
| }, | ||
| "link", | ||
| "~", | ||
| "undo", | ||
| "redo", | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ### Per-editor override | ||
|
|
||
| Override the toolbar for a specific editor using the HTML attribute: | ||
|
|
||
| ```html | ||
| <lexxy-editor toolbar='{"items":["bold","italic","link"]}'></lexxy-editor> | ||
| ``` | ||
|
|
||
| ### Disabling the toolbar | ||
|
|
||
| Pass `false` to hide the toolbar entirely: | ||
|
|
||
| ```html | ||
| <lexxy-editor toolbar="false"></lexxy-editor> | ||
| ``` | ||
|
|
||
| ## Separators and spacers | ||
|
|
||
| Use `"|"` between items to create visual groups. The separator renders as a thin vertical line (top-level) or a horizontal line (inside dropdowns). | ||
|
|
||
| Use `"~"` to insert a flexible spacer that pushes all following items to the right edge of the toolbar. This is typically used before undo/redo. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change removes styling for the existing
.separatorelement used insrc/elements/toolbar.js(e.g. the<div class="separator" role="separator">inside the format dropdown). With the current toolbar markup, dropdown separators will stop rendering. Either update the toolbar template/buildTemplate to stop emitting.separatorand instead applylexxy-editor__toolbar-group-end, or keep backward-compatible.separatorstyles here.