-
Notifications
You must be signed in to change notification settings - Fork 214
docs: RTE style variants and props #4870
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3c710ff
docs: RTE style variants and props
DiegoCardoso e8b17a6
remove description column
DiegoCardoso 8d791ac
Apply suggestions from code review
DiegoCardoso f6865eb
address review comments
DiegoCardoso f395411
update table
DiegoCardoso 6115e2e
Merge branch 'main' into docs/rte/styling-refactor
DiegoCardoso bbb28b2
Add CSS custom properties for toolbar button styling
DiegoCardoso 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
Some comments aren't visible on the classic Files Changed page.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,165 @@ order: 50 | |
| --- | ||
| = Rich Text Editor Styling | ||
|
|
||
| == Style Variants | ||
|
|
||
| The following variants are supported: | ||
|
|
||
| [cols="1,3,1"] | ||
| |=== | ||
| | Variant | Description | Supported by | ||
|
|
||
| |`compact` | ||
| | Makes the toolbar more compact | ||
| | Lumo | ||
|
|
||
| |`no-border` | ||
| | Removes the border around the editor | ||
| | Lumo | ||
|
|
||
| |=== | ||
|
|
||
| === Compact | ||
|
|
||
| Apply the `compact` style variant to make the toolbar more compact. | ||
|
|
||
| [.example] | ||
| -- | ||
|
|
||
| ifdef::lit[] | ||
| [source,html] | ||
| ---- | ||
| include::{root}/frontend/demo/component/richtexteditor/rich-text-editor-theme-compact.ts[render,tags=snippet,indent=0,group=Lit] | ||
| ---- | ||
| endif::[] | ||
|
|
||
| ifdef::flow[] | ||
| [source,java] | ||
| ---- | ||
| include::{root}/src/main/java/com/vaadin/demo/component/richtexteditor/RichTextEditorThemeCompact.java[render,tags=snippet,indent=0,group=Flow] | ||
| ---- | ||
| endif::[] | ||
|
|
||
|
|
||
| ifdef::react[] | ||
| [source,tsx] | ||
| ---- | ||
| include::{root}/frontend/demo/component/richtexteditor/react/rich-text-editor-theme-compact.tsx[render,tags=snippet,indent=0,group=React] | ||
| ---- | ||
| endif::[] | ||
| -- | ||
|
|
||
|
|
||
| === No Border | ||
|
|
||
| Apply the `no-border` style variant to remove Rich Text Editor’s border. An example of this is when the component is wrapped in a container with its own borders. | ||
|
|
||
| [.example] | ||
| -- | ||
|
|
||
| ifdef::lit[] | ||
| [source,html] | ||
| ---- | ||
| include::{root}/frontend/demo/component/richtexteditor/rich-text-editor-theme-no-border.ts[render,tags=snippet,indent=0,group=Lit] | ||
| ---- | ||
| endif::[] | ||
|
|
||
| ifdef::flow[] | ||
| [source,java] | ||
| ---- | ||
| include::{root}/src/main/java/com/vaadin/demo/component/richtexteditor/RichTextEditorThemeNoBorder.java[render,tags=snippet,indent=0,group=Flow] | ||
| ---- | ||
| endif::[] | ||
|
|
||
|
|
||
| ifdef::react[] | ||
| [source,tsx] | ||
| ---- | ||
| include::{root}/frontend/demo/component/richtexteditor/react/rich-text-editor-theme-no-border.tsx[render,tags=snippet,indent=0,group=React] | ||
| ---- | ||
| endif::[] | ||
| -- | ||
|
|
||
| include::../_styling-section-theming-props.adoc[tag=style-properties] | ||
|
|
||
| === Common Properties | ||
|
|
||
| [cols="3,1"] | ||
| |=== | ||
| | Property | Supported by | ||
|
|
||
| | `--vaadin-rich-text-editor-background` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-content-color` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-content-font-size` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-content-line-height` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-content-padding` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-background` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-gap` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-padding` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-button-background` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-button-border-color` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-button-border-radius` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-button-border-width` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-button-padding` | ||
| | Aura, Lumo | ||
|
|
||
| | `--vaadin-rich-text-editor-toolbar-button-text-color` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, done. |
||
| | Aura, Lumo | ||
|
|
||
| |=== | ||
|
|
||
| === Overlay Properties | ||
|
|
||
| [cols="3,1"] | ||
| |=== | ||
| | CSS Property | Supported by | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-gap` | ||
| | Aura | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-padding` | ||
| | Aura | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-color-option-border-color` | ||
| | Aura | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-color-option-border-radius` | ||
| | Aura | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-color-option-border-width` | ||
| | Aura | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-color-option-height` | ||
| | Aura | ||
|
|
||
| | `--vaadin-rich-text-editor-overlay-color-option-width` | ||
| | Aura | ||
| |=== | ||
|
|
||
| include::../_styling-section-intros.adoc[tag=selectors] | ||
|
|
||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.