Value
Last updated
Last updated
A Value
is the top-level representation of data in Slate, containing both a and a . It's what you need to pass into the Slate to render something onto the page.
data
Data
An object containing arbitrary data for the value.
decorations
List<Decoration>
A list of ranges in the document with marks that aren't part of the content itself—like matches for the current search string.
document
Document
The current document of the value.
object
String
A string with a value of 'value'
.
selection
Selection
The current selection of the value.
These properties aren't supplied when creating a Value
, but are instead computed based on the current document
and selection
.
{edge}Text
Text
{edge}Block
Block
marks
Set
activeMarks
Set
blocks
List
fragment
Document
inlines
List
texts
List
Value.create
Value.create(properties: Object) => Value
Create a new Value
instance with properties
.
Value.fromJSON
Value.fromJSON(object: Object) => Value
Create a value from a JSON object
.
Value.isValue
Value.isValue(any: Any) => Boolean
Returns a boolean if the passed in argument is a Value
.
toJSON
toJSON() => Object
Returns a JSON representation of the value.
Get the leaf node at {edge}
. Where {edge}
is one of: anchor
, focus
, start
or end
.
Get the leaf node at {edge}
. Where {edge}
is one of: anchor
, focus
, start
or end
.
Get a set of the in the current selection.
Get a subset of the that are present in all the characters in the current selection. It can be used to determine the active/inactive state of toolbar buttons corresponding to marks, based on the usual rich text editing conventions.
Get a list of the lowest-depth nodes in the current selection.
Get a fragment of the current selection.
Get a list of the lowest-depth nodes in the current selection.
Get a list of the nodes in the current selection.