https://github.com/GrapesJS/components-typed
GrapesJS Typed component made by wrapping Typed.js library
https://github.com/GrapesJS/components-typed
Last synced: 11 months ago
JSON representation
GrapesJS Typed component made by wrapping Typed.js library
- Host: GitHub
- URL: https://github.com/GrapesJS/components-typed
- Owner: GrapesJS
- License: mit
- Created: 2019-10-28T23:40:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-09T12:10:53.000Z (about 3 years ago)
- Last Synced: 2025-06-21T12:37:39.013Z (about 1 year ago)
- Language: TypeScript
- Size: 147 KB
- Stars: 22
- Watchers: 3
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GrapesJS Typed
GrapesJS Typed component made by wrapping Typed.js library
[DEMO](https://jsfiddle.net/artur_arseniev/xfvo50hj)
## Summary
* Plugin name: `grapesjs-typed`
* Components
* `typed` - Main component
| Prop | Description | Default |
|-|-|-
| `strings` | Strings to be typed | `[]` |
| `type-speed` | Type speed in milliseconds | `0` |
| `start-delay` | Time before typing starts in milliseconds | `0` |
| `back-speed` | Backspacing speed in milliseconds | `0` |
| `smart-backspace` | Only backspace what doesn't match the previous string | `true` |
| `back-delay` | Time before backspacing in milliseconds | `700` |
| `fade-out` | Fade out instead of backspace | `false` |
| `fade-out-class` | CSS class for fade animation | `typed-fade-out` |
| `fade-out-delay` | Fade out delay in milliseconds | `500` |
| `show-cursor` | Show cursor | `true` |
| `cursor-char` | Character for cursor | `\|` |
| `auto-insert-css` | Insert CSS for cursor and fadeOut into HTML `` | `true` |
| `bind-input-focus-events` | Bind to focus and blur if el is text input | `false` |
| `content-type` | 'html' or 'null' for plaintext | `html` |
| `loop` | Loop strings | `false` |
| `loop-count` | Amount of loops | `Infinity` |
| `shuffle` | Shuffle the strings | `false` |
* Blocks
* `typed` - Main block
* Traits
* `typed-strings` - Textarea input to handle strings (one string per row)
## Options
| Option | Description | Default |
|-|-|-
| `script` | Library to load asynchronously in case `Typed` is not found | [CDN](https://cdn.jsdelivr.net/npm/typed.js@2.0.11) |
| `block` | Object to extend the default block
eg. `{ label: 'Typed', ... }`
Pass a falsy value to avoid adding the block | `{}` |
| `props` | Customize component's props. The final object should be returned from the function | `props => props` |
## Download
* CDN
* `https://unpkg.com/grapesjs-typed`
* NPM
* `npm i grapesjs-typed`
* GIT
* `git clone https://github.com/artf/grapesjs-typed.git`
## Usage
Directly in the browser
```html
const editor = grapesjs.init({
container: '#gjs',
// ...
plugins: ['grapesjs-typed'],
pluginsOpts: {
'grapesjs-typed': { /* options */ }
}
});
```
Modern javascript
```js
import grapesjs from 'grapesjs';
import plugin from 'grapesjs-typed';
import 'grapesjs/dist/css/grapes.min.css';
const editor = grapesjs.init({
container : '#gjs',
// ...
plugins: [plugin],
pluginsOpts: {
[plugin]: { /* options */ }
}
// or
plugins: [
editor => plugin(editor, { /* options */ }),
],
});
```
## Development
Clone the repository
```sh
$ git clone https://github.com/artf/grapesjs-typed.git
$ cd grapesjs-typed
```
Install dependencies
```sh
$ npm i
```
Start the dev server
```sh
$ npm start
```
Build the source
```sh
$ npm run build
```
## License
MIT