Giter Club home page Giter Club logo

wordexpress-tools's Introduction

wordexpress-tools

Various tools used in the Vue and React WordExpress Starter Kits.

WordExpress Tools consist of the following:

  • WordExpress Helpers: These are various helper functions used by the WordExpress starter kits. They do things like parse page/post content

  • WordExpress Shortcodes: resolving functions that work with the WordExpress Database connectors to resolver GraphQL Queries

Installation

npm install --save wordexpress-schema

Usage

Using With Vue Starter Kit

Tools are used as part of the core Vue Starter Kit as a Vue plugin. The plugin is installed when creating the main Vue app, like so:

...
import {WordExpressShortcodes, WordExpressHelpers} from 'wordexpress-tools'

Vue.use(WordExpressPlugin, {
  shortcodes: WordExpressShortcodes,
  helpers: WordExpressHelpers
})
...

Custom Shortcodes

You can add your own custom shortcodes and helpers by extending each object.

//my-custom-shortcode.js
import {GetShortCode} from 'wordexpress-tools'

const MyCustomShortcode = line => {
  const shortcode = GetShortCode(line)
  const {params, content} = shortcode

  // return custom html here
  return (`<div>${content}</div>`)
}

export default MyCustomShortcode

Then, when you install the Vue plugin, simplty extend WordExpressShortcodes.

import {WordExpressShortcodes, WordExpressHelpers} from 'wordexpress-tools'
import MyCustomPlugin from './path/to/my-custom-plugin.js'

const shortcodes = {
  ...WordExpressShortcodes,
  nameOfCustomShortcode: MyCustomShortcode
}

Vue.use(WordExpressPlugin, {
  shortcodes,
  helpers: WordExpressHelpers
})

Now, in your Wordpress WYSIWYG you can use something like [nameOfCustomShortcodes param1="param"]content[/nameOfCustomShortcode]. Please not that the name of the shortcode has to match the key in the extended shortcode object.

wordexpress-tools's People

Contributors

ramsaylanier avatar

Watchers

 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.