https://github.com/sokeio/grapesjs-bootstrap
https://github.com/sokeio/grapesjs-bootstrap
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sokeio/grapesjs-bootstrap
- Owner: sokeio
- License: mit
- Created: 2023-09-21T15:01:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-29T19:22:23.000Z (over 1 year ago)
- Last Synced: 2025-04-11T16:37:38.324Z (about 2 months ago)
- Language: JavaScript
- Size: 199 KB
- Stars: 2
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grapesjs Bootstrap 5
[DEMO](##)
> **Provide a live demo of your plugin**
For a better user engagement create a simple live demo by using services like [JSFiddle](https://jsfiddle.net) [CodeSandbox](https://codesandbox.io) [CodePen](https://codepen.io) and link it here in your README (attaching a screenshot/gif will also be a plus).
To help you in this process here below you will find the necessary HTML/CSS/JS, so it just a matter of copy-pasting on some of those services. After that delete this part and update the link above
### HTML
```html
```
### JS
```js
const editor = grapesjs.init({
container: '#gjs',
height: '100%',
fromElement: true,
storageManager: false,
plugins: ['grapesjs-bootstrap'],
});
```
### CSS
```css
body, html {
margin: 0;
height: 100%;
}
```
## Summary
* Plugin name: `grapesjs-bootstrap`
* Components
* `component-id-1`
* `component-id-2`
* ...
* Blocks
* `block-id-1`
* `block-id-2`
* ...
## Options
| Option | Description | Default |
|-|-|-
| `option1` | Description option | `default value` |
## Download
* CDN
* `https://unpkg.com/grapesjs-bootstrap`
* NPM
* `npm i grapesjs-bootstrap`
* GIT
* `git clone https://github.com/BytePlatform/grapesjs-bootstrap.git`
## Usage
Directly in the browser
```html
var editor = grapesjs.init({
container: '#gjs',
// ...
plugins: ['grapesjs-bootstrap'],
pluginsOpts: {
'grapesjs-bootstrap': { /* options */ }
}
});
```
Modern javascript
```js
import grapesjs from 'grapesjs';
import plugin from 'grapesjs-bootstrap';
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/BytePlatform/grapesjs-bootstrap.git
$ cd grapesjs-bootstrap
```
Install dependencies
```sh
$ npm i
```
Start the dev server
```sh
$ npm start
```
Build the source
```sh
$ npm run build
```
## License
MIT