Skip to content
This repository was archived by the owner on May 31, 2020. It is now read-only.

Commit 69fffee

Browse files
committed
make draft-js dependency for utils
1 parent a322c02 commit 69fffee

File tree

3 files changed

+26
-33
lines changed

3 files changed

+26
-33
lines changed

packages/atomic-block/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
![file size](http://img.badgesize.io/https://unpkg.com/@djsp/atomic-block/dist/index.js?label=size&style=flat-square)
44
[![NPM](https://img.shields.io/npm/v/@djsp/atomic-block.svg)](https://www.npmjs.com/package/@djsp/atomic-block) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
55

6-
## Installation
6+
[Atomic blocks](https://draftjs.org/docs/advanced-topics-block-components#defining-custom-block-components) are draft-js's abstraction for displaying media that isn't text. Like images or embedded videos.
7+
8+
The Atomic block plugin solves two common problems:
9+
- Focusing atomic blocks.
10+
- Keyboard interaction with atomic blocks.
711

8-
`@djsp/atomic-block` depends on `@djsp/utils` which must also be installed.
12+
## Installation
913

1014
```sh
11-
npm install --save @djsp/utils @djsp/atomic-block
15+
npm install --save @djsp/utils @djsp/core @djsp/atomic-block
1216
# or alternately
1317
yarn add @djsp/utils @djsp/atomic-block
1418
```
@@ -29,5 +33,13 @@ yarn add @djsp/utils @djsp/atomic-block
2933
</EditorContainer>
3034
```
3135

36+
## API Props
37+
38+
- `type` - A `string`. Entity type of the atomic block. e.g. `IMAGE`, `VIDEO`, `EMBED` or whatever you want to call your block type :)
39+
- `children` - Render Prop.
40+
41+
42+
43+
3244
## Examples
3345
- [Editor with image](https://codesandbox.io/s/github/draft-js-plugins/next/tree/master/examples/atomic-block)

packages/utils/package-lock.json

Lines changed: 10 additions & 28 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/utils/package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
},
2424
"devDependencies": {
2525
"cross-env": "^5.1.4",
26-
"draft-js": "^0.10.5",
2726
"flow-bin": "^0.81.0",
2827
"flow-typed": "^2.5.1",
2928
"react": "^16.2.0",
@@ -36,7 +35,7 @@
3635
"files": [
3736
"dist"
3837
],
39-
"peerDependencies": {
38+
"dependencies": {
4039
"draft-js": "^0.10.5"
4140
}
4241
}

0 commit comments

Comments
 (0)