Skip to content

Anubhavjain786/grapesjs-accordion

Repository files navigation

grapesjs-accordion

NPM version NPM downloads Travis build Chat Discord GitHub issues dependencies status devDependencies status

DEMO

Requirements

- GrapesJS v0.13.8 or higher

HTML

<link
  href="https://unpkg.com/grapesjs/dist/css/grapes.min.css"
  rel="stylesheet"
/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="https://unpkg.com/grapesjs-accordion"></script>

<div id="gjs"></div>

JS

const editor = grapesjs.init({
  container: "#gjs",
  height: "100%",
  fromElement: true,
  storageManager: false,
  plugins: ["grapesjs-accordion"],
});

CSS

body,
html {
  margin: 0;
  height: 100%;
}

Summary

  • Plugin name: grapesjs-accordion
  • Components
    • accordions - Main accordions component
    • accordion-container - Component which contains a single accordion
    • accordion - Single accordion component
    • accordion-content - Accordion's content
  • Blocks
    • accordions

Options

Option Description Default
accordionsBlock Object to extend the default accordions block, eg. { label: 'Accordions', attributes: { ... } }. Pass a falsy value to avoid adding the block {}
accordionsProps Object to extend the default accordions properties, eg. { name: 'My Accordions', droppable: false, ... } {}
accordionProps Object to extend the default accordion properties {}
accordionContentProps Object to extend the default accordion content properties {}
accordionContainerProps Object to extend the default accordion container properties {}
attrAccordions Accordions attribute identifier (main component) data-accordions
attrAccordion Accordion attribute identifier data-accordion
attrAccordionContent Accordion content attribute identifier data-accordion-content
attrAccordionContainer Accordion container attribute identifier data-accordion-container
classAccordion Default class to use on accordion accordion
classAccordionActive Class used on accordions when active accordion-active
classAccordionContent Default class to use on accordion content accordion-content
classAccordionContainer Default class to use on accordion container accordion-container
selectorAccordion The attribute used inside accordions as a selector for accordion contents href
template Default accordions template <nav .... (check the source)
templateAccordionContent Default template for new added accordion contents <div>New Accordion Content</div>
style Default style for accordions .accordion { .... (check the source)

Download

  • CDN
    • https://unpkg.com/grapesjs-accordion
  • NPM
    • npm i grapesjs-accordion
  • GIT
    • git clone https://github.com/anubhavjain786/grapesjs-accordion.git

Usage

Directly in the browser

<link
  href="https://unpkg.com/grapesjs/dist/css/grapes.min.css"
  rel="stylesheet"
/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-accordion.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
    container: "#gjs",
    // ...
    plugins: ["grapesjs-accordion"],
    pluginsOpts: {
      "grapesjs-accordion": {
        /* options */
      },
    },
  });
</script>

Modern javascript

import grapesjs from 'grapesjs';
import plugin from 'grapesjs-accordion';
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

$ git clone https://github.com/anubhavjain786/grapesjs-accordion.git
$ cd grapesjs-accordion

Install dependencies

$ npm i

Start the dev server

$ npm start

Build the source

$ npm run build

License

MIT