Giter VIP home page Giter VIP logo

grapesjs-tabs's Introduction

GrapesJS Tabs

Simple tabs component plugin for GrapesJS

GrapesJS Tabs

Demo

Requirements

  • GrapesJS v0.13.8 or higher

Summary

  • Plugin name: grapesjs-tabs
  • Components
    • tabs - Main tabs component
    • tab-container - Component which contains single tabs
    • tab - Single tab component
    • tab-content - Tab's content
  • Blocks
    • tabs

Options

Option Description Default
tabsBlock Object to extend the default tabs block, eg. { label: 'Tabs', attributes: { ... } }. Pass a falsy value to avoid adding the block {}
tabsProps Object to extend the default tabs properties, eg. { name: 'My Tabs', droppable: false, ... } {}
tabProps Object to extend the default tab properties {}
tabContentProps Object to extend the default tab content properties {}
tabContainerProps Object to extend the default tab container properties {}
attrTabs Tabs attribute identifier (main component) data-tabs
attrTab Tab attribute identifier data-tab
attrTabContent Tab content attribute identifier data-tab-content
attrTabContainer Tab container attribute identifier data-tab-container
classTab Default class to use on tab tab
classTabActive Class used on tabs when active tab-active
classTabContent Default class to use on tab content tab-content
classTabContainer Default class to use on tab container tab-container
selectorTab The attribute used inside tabs as a selector for tab contents href
template Default tabs template <nav .... (check the source)
templateTabContent Default template for new added tab contents <div>New Tab Content</div>
style Default style for tabs .tab { .... (check the source)

Download

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

Usage

<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-tabs.min.js"></script>

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

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

Development

Clone the repository

$ git clone https://github.com/artf/grapesjs-tabs.git
$ cd grapesjs-tabs

Install dependencies

$ npm i

The plugin relies on GrapesJS via peerDependencies so you have to install it manually

$ npm i grapesjs --no-save

Start the dev server

$ npm start

License

BSD 3-Clause

grapesjs-tabs's People

Contributors

artf avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.