Skip to content

Commit

Permalink
Updating Kirki
Browse files Browse the repository at this point in the history
  • Loading branch information
aristath committed Jul 1, 2015
1 parent 2af2394 commit eeab08f
Show file tree
Hide file tree
Showing 160 changed files with 9,329 additions and 4,737 deletions.
10 changes: 10 additions & 0 deletions includes/plugins/kirki/.codeclimate.yml
@@ -0,0 +1,10 @@
languages:
Ruby: false
JavaScript: true
PHP: true
exclude_paths:
- "assets/*"
- "sample-config.php"
- "kirki-user-tests.php"
- "tests/*"
- "bin/*"
3 changes: 3 additions & 0 deletions includes/plugins/kirki/.coveralls.yml
@@ -0,0 +1,3 @@
coverage_clover: build/logs/clover.xml
service_name: travis-ci
src_dir: .
25 changes: 25 additions & 0 deletions includes/plugins/kirki/.editorconfig
@@ -0,0 +1,25 @@
# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org

# WordPress Coding Standards
# http://make.wordpress.org/core/handbook/coding-standards/

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab

[*.json]
indent_style = space
indent_size = 2

[*.css]
indent_style = space
indent_size = 2

[*.txt]
end_of_line = crlf
18 changes: 18 additions & 0 deletions includes/plugins/kirki/.gitignore
@@ -0,0 +1,18 @@
# npm #
#######
node_modules
npm-debug.log

# grunt-contrib-sass #
######################
.sass-cache

# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
7 changes: 7 additions & 0 deletions includes/plugins/kirki/.simplecov
@@ -0,0 +1,7 @@
require 'simplecov'
require 'coveralls'

SimpleCov.formatter = Coveralls::SimpleCov::Formatter
SimpleCov.start do
add_filter "/test/"
end
40 changes: 40 additions & 0 deletions includes/plugins/kirki/.travis.yml
@@ -0,0 +1,40 @@
language: php

sudo: false

notifications:
on_success: never
on_failure: change

php:
- 5.3
- 5.4
- 5.5
- 5.6
- hhvm
- nightly

env:
- WP_VERSION=latest WP_MULTISITE=0

matrix:
include:
- php: 5.3
env: WP_VERSION=latest WP_MULTISITE=1

before_script:
- bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
- curl -s http://getcomposer.org/installer | php
- php composer.phar install --dev --no-interaction

script:
- mkdir -p build/logs
- phpunit --coverage-clover build/logs/clover.xml
- find . \( -name '*kirki*.php' \) -exec php -lf {} \;

after_script:
- php vendor/bin/coveralls -v

after_success:
- coveralls
- bash <(curl -s https://codecov.io/bash)
22 changes: 22 additions & 0 deletions includes/plugins/kirki/Gruntfile.js
@@ -0,0 +1,22 @@
'use strict';
module.exports = function(grunt) {

grunt.initConfig({
sass: {
dist: {
files: [{
expand: true,
cwd: 'includes/controls/',
src: ['**/*.scss'],
dest: 'includes/controls/',
ext: '.css'
}]
}
}
});

grunt.loadNpmTasks('grunt-contrib-sass');

grunt.registerTask('default', ['sass']);

};
Empty file modified includes/plugins/kirki/LICENSE 100755 → 100644
Empty file.
61 changes: 61 additions & 0 deletions includes/plugins/kirki/README.md
@@ -0,0 +1,61 @@
# [Kirki](http://kirki.org) #

[![Build Status](https://travis-ci.org/reduxframework/kirki.svg?branch=master)](https://travis-ci.org/reduxframework/kirki) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/reduxframework/kirki/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/reduxframework/kirki/?branch=master) [![Code Climate](https://codeclimate.com/github/aristath/kirki/badges/gpa.svg)](https://codeclimate.com/github/aristath/kirki) [![Coverage Status](https://coveralls.io/repos/reduxframework/kirki/badge.svg?branch=master)](https://coveralls.io/r/reduxframework/kirki?branch=master) [![License](https://img.shields.io/badge/license-GPL--2.0%2B-red.svg)](https://raw.githubusercontent.com/reduxframework/kirki/master/LICENSE)

## The Kirki Toolkit

Kirki allows developers to add advanced controls to their customizer as well as customize the way the customizer looks and feels.

You can add beautiful options to your theme's customizer panel and allow your users to tweak any aspect of their theme.
You've got 23 control types that you can use, [styling options for the customizer](https://github.com/reduxframework/kirki/wiki/Styling-the-Customizer), as well as [automatic calculations for your styles](https://github.com/reduxframework/kirki/wiki/output) using the `output` argument on your controls.

You can use the default WordPress customizer syntax or one of the 2 alternative syntaxes that we have provided for you. Each project has different needs and we understand that, so the choice is up to you.

Converting from the default customizer to the syntax used by Kirki will only take a few minutes and will save you a lot of time in the long run. :)

The following controls are included in the Kirki Toolkit:

* checkbox
* color-alpha
* color
* custom
* dropdown-pages
* editor
* image
* multicheck
* number
* palette
* radio-buttonset
* radio-image
* radio
* select
* select2
* select2-multiple
* slider
* sortable
* switch
* text
* textarea
* toggle
* upload

For documentation and examples on how to use these controls, please visit [kirki.org](http://kirki.org/#fields).


## Installation

### Method 1: Use as a plugin
From your dashboard go to Plugins => Add New.
Search for "Kirki" and install it.
Once you install it, activate it.
For configuration instructions please visit [the wiki](https://github.com/reduxframework/kirki/wiki)

### Method 2: Embed in your theme
Please visit [the wiki page](https://github.com/reduxframework/kirki/wiki/Embedding-in-a-theme) for documentation and instructions.


### Sample data

The 2 last lines on the [kirki.php](https://github.com/reduxframework/kirki/blob/master/kirki.php) file are commented-out but if you uncomment them you will see your customizer flood with dummy controls.

[Changelog](https://github.com/aristath/kirki/wiki/Changelog)

0 comments on commit eeab08f

Please sign in to comment.