Code Monkey home page Code Monkey logo

uikit-gutenberg's Introduction

UIkit Gutenberg Blocks

Description

A set of blocks widht UIKit classes built into them for the Gutenberg editor in Wordpress. Version 1.0.0

These blocks aren't made to replace the standard gutenberg blocks, but instead to work with them.

The expectation is that you want to use UIKit for a quick page structure and use your own theme's styles separately.

Documentation for UIKit

This project was bootstrapped with Create Guten Block.

Features

Current Blocks

  • styleless-container, for a styleless div you can add classes to
  • uk-container
  • uk-grid
  • uk-accordion w/ uk-accordion-item
  • uk-lightbox w/ uk-lightbox-item
  • uk-card
  • uk-slideshow w/ uk-slideshow-item
  • uk-modal

Get Started

To Change/Add blocks

  1. Open the src folder in terminal
  2. Run npm install
  3. Run npm run start to develop, it will build the whole plugin everytime you save
  4. Duplicate the 'default-uikit-block'
  5. Find and replace 'default-uikit' with your new block name
  6. Start developing your block
  7. When you finish developing run npm run build for a more optimized build
  8. Make sure you add your new bloc kto the 'src/blocks.js' file

To add the blocks to your theme

  1. Create a folder in the plugin directory of your theme
  2. Add the dist folder and the plugin.php file to that directory
  3. Open one of your posts and type 'uk' inside the block search tool
  4. Try out each block and discover the power of UIKit with Gutenberg

Usage

Its very simple, ideally you would start with the uk-container block which would hold all of the other blocks.

If you want to style certain blocks differently outside of wordpress/uikit, you can add the styleless-container block and give it a class which you can use in your styles.

Every block has a few inspector controls that are the same for each, ex. text-align, margin, width, and visibility.

Some blocks have inspector controls that are specific to that block, ex. uk-grid which has a child width selector.

To request a new block, create an issue. Enjoy!

uikit-gutenberg's People

Contributors

braeden97 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.