README

What Is This

Depending on the size of a project, you may be able to get away with adding settings to an existing WordPress page (or the customizer). On the other end of the spectrum, you may need (or want) to implement a full-scale control panel like Redux. However, what if your project is somewhere in the middle? Alternatively, what if you need a control panel but don't want the bulk that goes along with most? This need is something that I've struggled with for some time. Origami is a simple, standards-compliant library for creating theme and plugin settings panels with a difference. Built on the core of the excellent system used by Easy Digital Downloads, Origami strives to be simple, extensible, and maintain a native look and feel.

Note: The license field is horribly outdated and should not be used in production without extensive testing until I have access to SL again and can properly update it.

More information can be found on the wiki.

Installation

Composer

Origami can be included in your project using Composer by adding it to your composer.json:

{
    "require": {
        "widgitlabs/origami": "*"
    }
}

Standalone

Origami can be included manually by downloading the latest release from the Releases page and extracting it in your project directory.

Demo Mode

Origami installations only include the actual settings library, but for testing and development use we also provide a full WordPress plugin including a "Demo Mode" which can be activated through the WordPress Plugins page. This option is currently only available through GitLab.

Prebuilt Package

For every release we provide a prebuilt version of the WordPress plugin, which can be downloaded through the GitLab Package Registry.

Git

$ git clone https://gitlab.com/widgitlabs/wordpress/origami.git

# or

$ git submodule add https://gitlab.com/widgitlabs/wordpress/origami.git

Bugs

If you find an issue, let us know here!

Contributions

Anyone is welcome to contribute to the library. Please read the guidelines for contributing to this repository.

There are various ways you can contribute:

Raise an Issue on GitLab
Send us a Pull Request with your bug fixes and/or new features
Provide feedback and suggestions on enhancements
Help translate Origami

widgitlabs / origami

Maintainers

Details