mirror of
https://github.com/webislife/wc-wysiwyg.git
synced 2025-07-20 06:16:09 +00:00
80
README.md
80
README.md
@ -1,5 +1,6 @@
|
||||
# wc-time
|
||||
WYWSIWYG HTML5 Editor written in TypeScript and designed by web-componennt, support all JS frameworks and browsers.
|
||||
# wc-wysiwyg custom element
|
||||
|
||||
WC-WSIWYG HTML5 Editor written in TypeScript and designed by web-componennt, support all JS frameworks and browsers.
|
||||
See full demo - [wc-wysiwyg demo](https://webislife.ru/demo/wc-wysiwyg/) list and demo of all editor features
|
||||
|
||||
|
||||
@ -9,28 +10,76 @@ See full demo - [wc-wysiwyg demo](https://webislife.ru/demo/wc-wysiwyg/) list an
|
||||
npm i wc-wysiwyg-editor --save
|
||||
```
|
||||
|
||||
## Features
|
||||
✅ Multilingual support via [HTMLElement.lang](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/lang) attribute 🇷🇺/🇺🇸 supported by default
|
||||
|
||||
✅ CSS styles for all popular HTML5 tags
|
||||
|
||||
✅ CSS support for 🔥 in bulleted lists
|
||||
|
||||
✅ Support for style inheritance via CSS class in the `data-content-class` attribute of emoji in bulleted lists
|
||||
|
||||
✅ Inline actions on selected text
|
||||
|
||||
✅ Storing value in `window.localStorage` and restoring after reload, check in comment form below
|
||||
|
||||
✅ Eetting editable properties of any tags, the number of tags and attributes are configurable
|
||||
✅ Autocomplete as you type / for supported tags in new paragraph
|
||||
|
||||
✅ Text\HTML5 view switcher
|
||||
|
||||
✅ Size Clear Button `Ⱦ`
|
||||
|
||||
✅ Live preview
|
||||
|
||||
- ✅ Keyboard Shortcuts
|
||||
- `ALT`+`SPACE` toggle the current caret pointer outside the tag
|
||||
- `ESCAPE` close bottom editor dialog box
|
||||
|
||||
✅ Validation required, minlength, maxlength, filtertags
|
||||
|
||||
✅ Inserting `<audio>` element
|
||||
|
||||
✅ Inserting `<video>` element
|
||||
|
||||
## Commands
|
||||
|
||||
Available package commands
|
||||
- Available package commands
|
||||
|
||||
Build scss styles
|
||||
```
|
||||
npm run sass
|
||||
```
|
||||
- Compile TypeScript
|
||||
```
|
||||
npm run tsc
|
||||
```
|
||||
- Minify code with babel-minify after TypeScript compile
|
||||
```
|
||||
npm run babel-minify
|
||||
```
|
||||
build all stpes 1.sass 2.tsc 3.babel-minif
|
||||
|
||||
```
|
||||
`npm run sass' - build scss styles
|
||||
`npm run tsc' - run typescript
|
||||
`npm run babel-minify' - minify code after typescript
|
||||
`npm run build' - build all stpes 1.sass 2.tsc 3.babel-minify
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Custom element demo
|
||||
## Integration WC-WYSIWYG element demo
|
||||
<!--
|
||||
```
|
||||
<custom-element-demo>
|
||||
<template>
|
||||
<link rel="import" href="index.html">
|
||||
<next-code-block></next-code-block>
|
||||
</template>
|
||||
</custom-element-demo>
|
||||
<wc-wysiwyg value="foo">
|
||||
<textarea></textarea>
|
||||
</wc-wysiwyg>
|
||||
```
|
||||
-->
|
||||
First, include JS and define custom element
|
||||
```javascript
|
||||
import('/src/components/wc-wysiwyg.js').then(esm => {
|
||||
esm.define();
|
||||
});
|
||||
```
|
||||
And use in HTML
|
||||
|
||||
```html
|
||||
<wc-wysiwyg id="wc-demo-comment"
|
||||
data-allow-tags="strong,u,i,b,q,blockquote,a,img,pre"
|
||||
@ -44,8 +93,9 @@ Available package commands
|
||||
</wc-wysiwyg>
|
||||
```
|
||||
|
||||
|
||||
See full demo - [wc-wysiwyg demo](https://webislife.ru/demo/wc-wysiwyg/) list and demo of all editor features
|
||||
|
||||
Dont forgot star on git! Thank you! Enojoy!
|
||||
|
||||
Dev by strokoff.ru - make web, not war)
|
||||
Dev by strokoff - make web, not war)
|
@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "wc-wysiwyg-editor",
|
||||
"name": "@webislife/wc-wysiwyg-editor",
|
||||
"version": "0.9.1",
|
||||
"description": "WYWSIWYG HTML5 Editor written in ts and designed by web-componennt, support all JS frameworks and browsers",
|
||||
"main": "src/wc-wysiwyg.ts",
|
||||
|
Reference in New Issue
Block a user