├── .babelrc
├── .eslintignore
├── .eslintrc
├── .flowconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── example
├── index.html
├── main.css
├── main.js
└── value.js
├── lib
├── changes
│ ├── index.js
│ ├── unwrapBlockquote.js
│ └── wrapInBlockquote.js
├── core.js
├── handlers
│ ├── index.js
│ ├── onBackspace.js
│ ├── onEnter.js
│ ├── onKeyDown.js
│ └── onModEnter.js
├── index.js
├── options.js
├── utils
│ ├── getCurrentBlockquote.js
│ ├── index.js
│ └── isSelectionInBlockquote.js
└── validation
│ ├── index.js
│ └── schema.js
├── package.json
├── tests
├── all.js
├── backspace-quote-in-quote
│ ├── change.js
│ ├── expected.yaml
│ └── input.yaml
├── backspace-start-block
│ ├── change.js
│ ├── expected.yaml
│ └── input.yaml
├── enter-empty-middle
│ ├── change.js
│ ├── expected.yaml
│ └── input.yaml
├── enter-withtext-middle
│ ├── change.js
│ ├── expected.yaml
│ └── input.yaml
├── is-in-blockquote
│ ├── change.js
│ └── input.yaml
└── schema-items-contain-blocks
│ ├── change.js
│ ├── expected.yaml
│ └── input.yaml
└── yarn.lock
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | "es2015",
4 | "stage-0",
5 | "react"
6 | ],
7 | "plugins": [
8 | "transform-flow-strip-types"
9 | ]
10 | }
11 |
--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | dist/
2 | example/bundle.js
3 | node_modules/
4 |
--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 | "parser": "babel-eslint",
3 | "extends": [
4 | "gitbook"
5 | ],
6 | "rules": {
7 | "no-param-reassign": 1,
8 | "import/no-commonjs": 2
9 | },
10 | "plugins": [
11 | "flowtype"
12 | ],
13 | "env": {
14 | "mocha": true
15 | },
16 | }
17 |
--------------------------------------------------------------------------------
/.flowconfig:
--------------------------------------------------------------------------------
1 | [options]
2 | emoji=true
3 | esproposal.decorators=ignore
4 | unsafe.enable_getters_and_setters=true
5 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 |
6 | # Runtime data
7 | pids
8 | *.pid
9 | *.seed
10 |
11 | # Directory for instrumented libs generated by jscoverage/JSCover
12 | lib-cov
13 |
14 | # Coverage directory used by tools like istanbul
15 | coverage
16 |
17 | # nyc test coverage
18 | .nyc_output
19 |
20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
21 | .grunt
22 |
23 | # node-waf configuration
24 | .lock-wscript
25 |
26 | # Compiled binary addons (http://nodejs.org/api/addons.html)
27 | build/Release
28 |
29 | # Dependency directories
30 | node_modules
31 | jspm_packages
32 |
33 | # Optional npm cache directory
34 | .npm
35 |
36 | # Optional REPL history
37 | .node_repl_history
38 |
39 | dist
40 | example/bundle.js
41 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | lib
2 | !dist
3 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | sudo: false
2 | language: node_js
3 | node_js:
4 | - "stable"
5 | after_script:
6 | - npm run lint
7 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Change Log
2 | All notable changes to this project will be documented in this file.
3 |
4 | The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
5 |
6 | ### [0.7.0] - 2019-02-01
7 |
8 | - Add option `exitBlockType` to exit blockquote on Mod+Enter
9 |
10 | ### [0.6.1] - 2018-04-19
11 |
12 | - Reduce package size by publishing only the `dist` folder
13 |
14 | ### [0.6.0] - 2018-03-22
15 |
16 | - Use slate schema definition
17 | - Upgrade to slate ^0.33.0
18 |
19 | ### [0.5.0] - 2017-11-08
20 |
21 | - Upgrade to slate ^0.29.0
22 |
23 | ### [0.4.0] - 2017-09-19
24 |
25 | - Upgrade to be compatible with Slate after the `expose-transform` branch went in.
26 | - Change all instances of `transform` to `change`
27 | - Change the namespace of `plugin.transforms` to `plugin.changes`
28 |
29 | ## [0.3.0] - 2017-09-11
30 | - Update to slate 0.22.x
31 |
32 | ## [0.2.0] - 2016-11-30
33 | - Update to slate 0.15.x
34 | - Enforce blocks in blockquotes using schema
35 |
36 | ## [0.1.3] - 2016-11-03
37 | - Move slate to `peerDependencies`
38 |
39 | ## [0.1.2] - 2016-09-30
40 | - Now publish compiled source with babel
41 |
42 | ## [0.1.1] - 2016-09-19
43 | - Use of this plugin with other container plugins (such as `slate-edit-list`)
44 |
45 | ## [0.1.0] - 2016-09-17
46 | - First version
47 | - Handle pressing enter in a blockquote
48 | - Handle pressing backspace
49 | - Provides utilities and transforms
50 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | > ⚠️ This repository is archived and has moved to [GitBook's fork](https://github.com/GitbookIO/slate) of [ianstormtaylor/slate](https://github.com/ianstormtaylor/slate).
2 | > Previous versions are still [available on NPM](https://www.npmjs.com/package/slate-edit-table)
3 | > All the versions using GitBook's fork of slate are now published under the `@gitbook` NPM scope.
4 | > To learn more about why we forked Slate, read [our manifest](https://github.com/GitbookIO/slate/blob/master/Forked.md)
5 |
6 | # slate-edit-blockquote
7 |
8 | [](http://badge.fury.io/js/slate-edit-blockquote)
9 | [](https://travis-ci.org/GitbookIO/slate-edit-blockquote)
10 |
11 | A Slate plugin to handle keyboard events in blockquotes. Blockquotes can contain blocks.
12 |
13 | ### Install
14 |
15 | ```
16 | npm install slate-edit-blockquote
17 | ```
18 |
19 | ### Features
20 |
21 | Natural keybindings:
22 |
23 | - Pressing Enter in an empty block of a blockquote, exits the blockquote
24 | - Pressing Backspace at the start of a block in a blockquote, unwraps from the blockquote
25 |
26 | ### Simple Usage
27 |
28 | ```js
29 | import EditBlockquote from 'slate-edit-blockquote'
30 |
31 | const plugins = [
32 | EditBlockquote()
33 | ]
34 | ```
35 |
36 | #### Arguments
37 |
38 | This plugin accepts options to redefine the following block types:
39 |
40 | - ``[type: String]`` — type for blockquotes
41 | - ``[typeDefault: String]`` — type for default block in blockquote.
42 |
43 | ### Utilities
44 |
45 | `slate-edit-blockquote` exports utilities and changes:
46 |
47 | #### `utils.isSelectionInBlockquote`
48 |
49 | `plugin.utils.isSelectionInBlockquote(value: Value) => Boolean`
50 |
51 | Return true if selection is inside a blockquote (and it can be unwrap).
52 |
53 | #### `changes.wrapInBlockquote`
54 |
55 | `plugin.changes.wrapInBlockquote(change: Change) => Change`
56 |
57 | Wrap current block in a new blockquote.
58 |
59 | #### `changes.unwrapBlockquote`
60 |
61 | `plugin.changes.unwrapBlockquote(change: Change) => Change`
62 |
63 | Unwrap from current blockquote if any.
64 |
--------------------------------------------------------------------------------
/example/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Slate • Blockquote Edition
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/example/main.css:
--------------------------------------------------------------------------------
1 | #example {
2 | width: 100%;
3 | max-width: 600px;
4 | margin: 20px auto;
5 | }
6 |
7 | #example blockquote {
8 | padding-left: 10px;
9 | margin-left: 0px;
10 | border-left: 3px solid #e5e5e5;
11 | }
12 |
--------------------------------------------------------------------------------
/example/main.js:
--------------------------------------------------------------------------------
1 | // @flow
2 | /* eslint-disable import/no-extraneous-dependencies */
3 | /* global document */
4 | import React from 'react';
5 | import ReactDOM from 'react-dom';
6 | import { Editor } from '@gitbook/slate-react';
7 | import PluginEditBlockquote from '../lib/';
8 |
9 | import INITIAL_VALUE from './value';
10 |
11 | const plugin = PluginEditBlockquote();
12 | const plugins = [plugin];
13 |
14 | function renderNode(props: *) {
15 | const { node, children, attributes } = props;
16 | switch (node.type) {
17 | case 'blockquote':
18 | return