mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-22 15:02:51 +02:00
Code Issues Releases Wiki Activity

Adding , adding documentation, adding some basic tests (#1045)

Browse Source
This commit is contained in:
Ryan Yurkanin
2017-09-05 12:13:40 -04:00
committed by Ian Storm Taylor
parent 7cfbbfc5e4
commit 9faaccd8ed
14 changed files with 207 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/models/transform.md
View File

@@ -56,6 +56,7 @@ Transform methods can either operate on the [`Document`](./document.md), the [`S
- [Node Transforms](#node-transforms)
- [`addMarkByKey`](#addmarkbykey)
- [`insertNodeByKey`](#insertnodebykey)
- [`insertFragmentByKey`](#insertfragmentbykey)
- [`insertTextByKey`](#inserttextbykey)
- [`moveNodeByKey`](#movenodebykey)
- [`removeMarkByKey`](#removemarkbykey)
@@ -332,6 +333,11 @@ Add a `mark` to `length` characters starting at an `offset` in a [`Node`](./node
Insert a `node` at `index` inside a parent [`Node`](./node.md) by its `key`.
### `insertFragmentByKey`
`insertFragmentByKey(key: String, index: Number, fragment: Fragment) => Transform`
Insert a [`Fragment`](./fragment.md) at `index` inside a parent [`Node`](./node.md) by its `key`.
### `insertTextByKey`
`insertTextByKey(key: String, offset: Number, text: String, [marks: Set]) => Transform`

21
src/transforms/by-key.js
View File

@@ -37,6 +37,27 @@ Transforms.addMarkByKey = (transform, key, offset, length, mark, options = {}) =
}
}
/**
* Insert a `fragment` at `index` in a node by `key`.
*
* @param {Transform} transform
* @param {String} key
* @param {Number} index
* @param {Fragment} fragment
* @param {Object} options
* @property {Boolean} normalize
*/
Transforms.insertFragmentByKey = (transform, key, index, fragment, options = {}) => {
const { normalize = true } = options
fragment.nodes.forEach((node, i) => transform.insertNodeByKey(key, index + i, node))
if (normalize) {
transform.normalizeNodeByKey(key, SCHEMA)
}
}
/**
* Insert a `node` at `index` in a node by `key`.
*

12
test/transforms/fixtures/by-key/insert-fragment-by-key/end-of-target/fragment.yaml Normal file
View File

@@ -0,0 +1,12 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment2

18
test/transforms/fixtures/by-key/insert-fragment-by-key/end-of-target/index.js Normal file
View File

@@ -0,0 +1,18 @@
import path from 'path'
import readMetadata from 'read-metadata'
import { Raw } from '../../../../../..'
export default function (state) {
const file = path.resolve(__dirname, 'fragment.yaml')
const raw = readMetadata.sync(file)
const fragment = Raw.deserialize(raw, { terse: true }).document
const { document } = state
const end = document.nodes.size
return state
.transform()
.insertFragmentByKey(document.key, end, fragment)
.apply()
}

7
test/transforms/fixtures/by-key/insert-fragment-by-key/end-of-target/input.yaml Normal file
View File

@@ -0,0 +1,7 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: word

17
test/transforms/fixtures/by-key/insert-fragment-by-key/end-of-target/output.yaml Normal file
View File

@@ -0,0 +1,17 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: word
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment2

12
test/transforms/fixtures/by-key/insert-fragment-by-key/middle-of-target/fragment.yaml Normal file
View File

@@ -0,0 +1,12 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment2

17
test/transforms/fixtures/by-key/insert-fragment-by-key/middle-of-target/index.js Normal file
View File

@@ -0,0 +1,17 @@
import path from 'path'
import readMetadata from 'read-metadata'
import { Raw } from '../../../../../..'
export default function (state) {
const file = path.resolve(__dirname, 'fragment.yaml')
const raw = readMetadata.sync(file)
const fragment = Raw.deserialize(raw, { terse: true }).document
const { document } = state
return state
.transform()
.insertFragmentByKey(document.key, 2, fragment)
.apply()
}

17
test/transforms/fixtures/by-key/insert-fragment-by-key/middle-of-target/input.yaml Normal file
View File

@@ -0,0 +1,17 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: word
- kind: block
type: paragraph
nodes:
- kind: text
text: word2
- kind: block
type: paragraph
nodes:
- kind: text
text: word3

27
test/transforms/fixtures/by-key/insert-fragment-by-key/middle-of-target/output.yaml Normal file
View File

@@ -0,0 +1,27 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: word
- kind: block
type: paragraph
nodes:
- kind: text
text: word2
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment2
- kind: block
type: paragraph
nodes:
- kind: text
text: word3

12
test/transforms/fixtures/by-key/insert-fragment-by-key/start-of-target/fragment.yaml Normal file
View File

@@ -0,0 +1,12 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment2

17
test/transforms/fixtures/by-key/insert-fragment-by-key/start-of-target/index.js Normal file
View File

@@ -0,0 +1,17 @@
import path from 'path'
import readMetadata from 'read-metadata'
import { Raw } from '../../../../../..'
export default function (state) {
const file = path.resolve(__dirname, 'fragment.yaml')
const raw = readMetadata.sync(file)
const fragment = Raw.deserialize(raw, { terse: true }).document
const { document } = state
return state
.transform()
.insertFragmentByKey(document.key, 0, fragment)
.apply()
}

7
test/transforms/fixtures/by-key/insert-fragment-by-key/start-of-target/input.yaml Normal file
View File

@@ -0,0 +1,7 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: word

17
test/transforms/fixtures/by-key/insert-fragment-by-key/start-of-target/output.yaml Normal file
View File

@@ -0,0 +1,17 @@
nodes:
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment
- kind: block
type: paragraph
nodes:
- kind: text
text: fragment2
- kind: block
type: paragraph
nodes:
- kind: text
text: word