Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 2.52 KB

README.md

File metadata and controls

55 lines (43 loc) · 2.52 KB
Raw

Gutenstrap Blocks - Bootstrap 4 blocks for Gutenberg WordPress editor.


Gutenstrap Blocks

WordPress plugin page


This plugin adds Bootstrap 4 components and grid layout to Gutenberg WordPress editor. It enhances editing experience focusing on making the most of library's documented features. Combine power of Gutenberg and Bootstrap to create a layout of any complexity with ease!

Supported Bootstrap blocks and formats:

  • Container - includes fluid container
  • Row - includes flexbox vertical and horizontal alignment classes and no gutters class
  • Column - allows to set equal sized columns, auto size, number column size and offset
  • Button - theme color selector, outline and block styles, small and large sizes
  • Alert - theme color selector, includes dismissible alerts and allows to nest other blocks
  • Badge - theme color selector, includes pill style

You can even nest rows!

Bootstrap library

CSS is included in the admin area to make editing in Gutenberg easier and styles are prefixed with .bootstrap-styles class. You can choose if you want to include to Bootstrap 4.3.1 on the front-end if you aren't using Bootstrap based theme.

You can customize Bootstrap styles in the editor. Prefix your styles with .bootstrap-styles class and include prefixed Bootstrap 4 css on admin side.

Example of how to prefix styles using SCSS:

.bootstrap-styles {
    @import '~bootstrap/scss/bootstrap';
}

Requirements

  • WordPress >= 5.2
  • PHP >= 5.6

Development

This project was bootstrapped with Create Guten Block.

npm start

  • Use to compile and run the block in development mode.
  • Watches for any changes and reports back any errors in your code.

npm run build

  • Use to build production code for your block inside dist folder.
  • Runs once and reports back the gzip file sizes of the produced code.

npm run eject

  • Use to eject your plugin out of create-guten-block.
  • Provides all the configurations so you can customize the project as you want.
  • It's a one-way street, eject and you have to maintain everything yourself.
  • You don't normally have to eject a project because by ejecting you lose the connection with create-guten-block and from there onwards you have to update and maintain all the dependencies on your own.