mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-09-02 03:32:36 +02:00
Allow void elements to receive marks (#5135)
Some void elements are effectively stand-ins for text, such as with the mentions example, where the mention element renders the character's name. Users might want to format Void elements like this with bold, or set their font and size, so `editor.markableVoid` tells Slate whether or not to apply Marks to the text children of void elements. - Adds `markableVoid()` as a schema-specific overrideable test. - Changes `addMark` and `removeMark` so marks can apply to voids. Also changes behavior of collapsed selection so that if a markable Void is selected, the mark will be applied / removed. - Shows how `markableVoid()` can work in the mentions example
This commit is contained in:
@@ -31,6 +31,10 @@ A "block" element can only be siblings with other "block" elements. An "inline"
|
||||
|
||||
In a not "void" element, Slate handles the rendering of its `children` (e.g. in a paragraph where the `Text` and `Inline` children are rendered by Slate). In a "void" element, the `children` are rendered by the `Element`'s render code.
|
||||
|
||||
#### Voids That Support Marks
|
||||
|
||||
Some void elements are effectively stand-ins for text, such as with the [Mentions](https://www.slatejs.org/examples/mentions) example, where the mention element renders the character's name. Users might want to format Void elements like this with bold, or set their font and size, so `editor.markableVoid` tells Slate whether or not to apply Marks to the text children of void elements.
|
||||
|
||||
#### Rendering Void Elements
|
||||
|
||||
Void Elements must
|
||||
@@ -50,6 +54,42 @@ return (
|
||||
)
|
||||
```
|
||||
|
||||
For a "markable" void such as a `mention` element, marks on the empty child element can be used to determine how the void element is rendered (Slate Marks are applied only to Text leaves):
|
||||
|
||||
```javascript
|
||||
const Mention = ({ attributes, children, element }) => {
|
||||
const selected = useSelected()
|
||||
const focused = useFocused()
|
||||
const style: React.CSSProperties = {
|
||||
padding: '3px 3px 2px',
|
||||
margin: '0 1px',
|
||||
verticalAlign: 'baseline',
|
||||
display: 'inline-block',
|
||||
borderRadius: '4px',
|
||||
backgroundColor: '#eee',
|
||||
fontSize: '0.9em',
|
||||
boxShadow: selected && focused ? '0 0 0 2px #B4D5FF' : 'none',
|
||||
}
|
||||
// See if our empty text child has any styling marks applied and apply those
|
||||
if (element.children[0].bold) {
|
||||
style.fontWeight = 'bold'
|
||||
}
|
||||
if (element.children[0].italic) {
|
||||
style.fontStyle = 'italic'
|
||||
}
|
||||
return (
|
||||
<span
|
||||
{...attributes}
|
||||
contentEditable={false}
|
||||
data-cy={`mention-${element.character.replace(' ', '-')}`}
|
||||
style={style}
|
||||
>
|
||||
{children}@{element.character}
|
||||
</span>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
## Static methods
|
||||
|
||||
### Retrieval methods
|
||||
|
Reference in New Issue
Block a user