-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1ae78f4
commit 34fb11c
Showing
21 changed files
with
2,840 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
build/ | ||
dist/ | ||
node_modules/ | ||
.snapshots/ | ||
*.min.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
{ | ||
"parser": "babel-eslint", | ||
"extends": [ | ||
"standard", | ||
"standard-react", | ||
"plugin:prettier/recommended", | ||
"prettier/standard", | ||
"prettier/react" | ||
], | ||
"env": { | ||
"node": true | ||
}, | ||
"parserOptions": { | ||
"ecmaVersion": 2020, | ||
"ecmaFeatures": { | ||
"legacyDecorators": true, | ||
"jsx": true | ||
} | ||
}, | ||
"settings": { | ||
"react": { | ||
"version": "16" | ||
} | ||
}, | ||
"rules": { | ||
"space-before-function-paren": 0, | ||
"react/prop-types": 0, | ||
"react/jsx-handler-names": 0, | ||
"react/jsx-fragments": 0, | ||
"react/no-unused-prop-types": 0, | ||
"import/export": 0 | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# OS Files | ||
.DS_Store | ||
Thumbs.db | ||
|
||
# Dependencies | ||
node_modules/ | ||
|
||
# Dev/Build Artifacts | ||
/tests/e2e/videos/ | ||
/tests/e2e/screenshots/ | ||
/tests/unit/coverage/ | ||
jsconfig.json | ||
|
||
# Local Env Files | ||
.env.local | ||
.env.*.local | ||
|
||
# Log Files | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Unconfigured Editors | ||
.idea | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw* | ||
#Yarn | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"singleQuote": true, | ||
"jsxSingleQuote": true, | ||
"semi": false, | ||
"tabWidth": 2, | ||
"bracketSpacing": true, | ||
"jsxBracketSameLine": false, | ||
"arrowParens": "always", | ||
"trailingComma": "none" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
language: node_js | ||
node_js: | ||
- 12 | ||
- 10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
1.0.0 (JULY 24, 2020) | ||
Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,129 @@ | ||
# ReactJS-CK-Editor | ||
# ReactJS - CKEditor / WYSIWYG Editor | ||
|
||
A simple, native and easy-to-use WYSIWYG / Rich Text editor built in Quill.js and React.js | ||
|
||
## Table of contents | ||
|
||
- [Browser Support](#browser-support) | ||
- [Demo](#demo) | ||
- [Getting started](#getting-started) | ||
- [Usage](#usage) | ||
- [Available Props](#available-props) | ||
- [Methods](#methods) | ||
- [Want to Contribute?](#want-to-contribute) | ||
- [Collection of Components](#collection-of-components) | ||
- [Changelog](#changelog) | ||
- [Credits](#credits) | ||
- [License](#license) | ||
- [Keywords](#Keywords) | ||
|
||
## Browser Support | ||
|
||
| ![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) | | ||
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | ||
| 83.0 ✔ | 77.0 ✔ | 13.1.1 ✔ | 83.0 ✔ | 11.9 ✔ | | ||
|
||
## Demo | ||
|
||
[![](editor.gif)](https://github.com/weblineindia/ReactJS-CK-Editor/editor.gif) | ||
|
||
## Getting started | ||
|
||
Install the npm package: | ||
|
||
```bash | ||
npm install react-weblineindia-ck-editor | ||
#OR | ||
yarn add react-weblineindia-ck-editor | ||
``` | ||
|
||
## Usage | ||
|
||
Use the `<react-weblineindia-ck-editor>` component: | ||
|
||
```js | ||
import React, { Component } from "react"; | ||
import Editor from "react-weblineindia-ck-editor"; | ||
class Test extends Component { | ||
constructor(props) { | ||
super(props); | ||
this.state = { | ||
editorHtml :'' | ||
} | ||
handleChange(html){ | ||
this.setState({ | ||
editorHtml : html | ||
}) | ||
} | ||
render(){ | ||
return( | ||
<div> | ||
<Editor | ||
onChange={this.handleChange.bind(this)} | ||
value={this.state.editorHtml} | ||
bounds={".app"} | ||
placeholder="Type Something" | ||
/> | ||
</div> | ||
) | ||
} | ||
} | ||
export default Test; | ||
|
||
``` | ||
## Available Props | ||
| Name | Type | Default | Description | | ||
| --------------------- | ------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------- | | ||
| id | String | quill-container | Set the id (necessary if multiple editors in the same view) | | ||
| placeholder | String | - | Placeholder text for the editor | | ||
| value | String | - | Set value to the the content or data property you wish to bind it to | | ||
| modules | object | | Set modules | | ||
| toolbar | Array | | Set toolbar | | ||
| formats | Array | | Set formats | | ||
## Methods | ||
| Name | Parameters | Description | | ||
| ---------------- | ---------------------------- | ----------------------------------------------------------------------------------- | | ||
| blur | quill | Emitted on `blur` event | | ||
| focus | quill | Emitted on `focus` event | | ||
| onChange | | Emitted on `change` event | | ||
| onKeyPress | | Emitted on `keypress` event | | ||
| onKeyDown | | Emitted on `keydown` event | | ||
| onKeyUp | | Emitted on `keyup` event | | ||
## Want to Contribute? | ||
- Created something awesome, made this code better, added some functionality, or whatever (this is the hardest part). | ||
- [Fork it](http://help.github.com/forking/). | ||
- Create new branch to contribute your changes. | ||
- Commit all your changes to your branch. | ||
- Submit a [pull request](http://help.github.com/pull-requests/). | ||
--- | ||
## Collection of Components | ||
We have built many other components and free resources for software development in various programming languages. Kindly click here to view our [Free Resources for Software Development](https://www.weblineindia.com/software-development-resources.html) | ||
--- | ||
## Changelog | ||
Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md). | ||
## Credits | ||
react-weblineindia-ck-editor is inspired by [react-quill](https://www.npmjs.com/package/react-quill). | ||
## License | ||
[MIT](LICENSE) | ||
[mit]: https://github.com/weblineindia/ReactJS-CK-Editor/blob/master/LICENSE | ||
## Keywords | ||
react-weblineindia-ck-editor, react-ck-editor, reactjs-ck-editor, react-editor, react-ckeditor, rich-text-editor, wysiwyg-editor, reactjs-wysiwyg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/* add css module styles here (optional) */ | ||
|
||
._styles-module__test__3ybTi { | ||
margin: 2em; | ||
padding: 0.5em; | ||
border: 2px solid #000; | ||
font-size: 2em; | ||
text-align: center; | ||
} |
Oops, something went wrong.