2020-03-11 14:32:45 +01:00
=== Kirki Customizer Framework ===
2020-07-12 11:19:40 +02:00
Contributors: davidvongries, aristath, dannycooper, wplemon, igmoweb
2020-03-11 14:32:45 +01:00
Tags: customizer, options framework, theme, mods, toolkit, gutenberg
Requires at least: 4.9
2020-08-10 18:52:31 +02:00
Tested up to: 5.5
Stable tag: 3.1.5
2020-03-11 14:32:45 +01:00
License: MIT
License URI: https://opensource.org/licenses/MIT
2020-07-12 11:19:40 +02:00
The ultimate customizer framework for WordPress theme developers.
2020-03-11 14:32:45 +01:00
== Description ==
[](https://travis-ci.org/aristath/kirki) [](https://codeclimate.com/github/aristath/kirki) [](https://opensource.org/licenses/MIT) [](https://www.codacy.com/app/aristath/kirki?utm_source=github.com&utm_medium=referral&utm_content=aristath/kirki&utm_campaign=Badge_Grade) [](https://scrutinizer-ci.com/g/aristath/kirki/?branch=develop)
2020-07-12 11:19:40 +02:00
[Kirki](https://kirki.org/?utm_source=repo&utm_medium=description&utm_campaign=kirki) allows theme developers to build themes quicker & more easily.
With over **30 custom controls** ranging from simple sliders to complex typography controls with Google-Fonts integration and features like automatic CSS & `postMessage` script generation, Kirki makes theme development a breeze.
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
### Features ###
* Increased Performance
* Simplified API
* Automatic CSS Generation
* Automatic postMessage Generation
* Partial Refresh
* Conditional Logic
* GDPR Compliance
* Improved Page Speed
* & more!
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
### Controls ###
2020-03-11 14:32:45 +01:00
* [Background Customizer Control](https://kirki.org/docs/controls/background)
* [Checkbox Customizer Control](https://kirki.org/docs/controls/checkbox)
* [Code Customizer Control](https://kirki.org/docs/controls/code)
* [Color Palette Customizer Control](https://kirki.org/docs/controls/color-palette)
* [Color Customizer Control](https://kirki.org/docs/controls/color)
* [Custom Customizer Control](https://kirki.org/docs/controls/custom)
* [Dashicons Customizer Control](https://kirki.org/docs/controls/dashicons)
* [Date Customizer Control](https://kirki.org/docs/controls/date)
* [Dropdown Pages Customizer Control](https://kirki.org/docs/controls/dropdown-pages)
* [Editor Customizer Control](https://kirki.org/docs/controls/editor)
* [Generic Customizer Control](https://kirki.org/docs/controls/generic)
* [Image Customizer Control](https://kirki.org/docs/controls/image)
* [Link Customizer Control](https://kirki.org/docs/controls/link)
* [Multiple Checkbox Customizer Control](https://kirki.org/docs/controls/multicheck)
* [Multicolor Customizer Control](https://kirki.org/docs/controls/multicolor)
* [Number Customizer Control](https://kirki.org/docs/controls/number)
* [Radio Buttonset Customizer Control](https://kirki.org/docs/controls/radio-buttonset)
* [Radio Image Customizer Control](https://kirki.org/docs/controls/radio-image)
* [Radio Customizer Control](https://kirki.org/docs/controls/radio)
* [Repeater Customizer Control](https://kirki.org/docs/controls/repeater)
* [Select Customizer Control](https://kirki.org/docs/controls/select)
* [Slider Customizer Control](https://kirki.org/docs/controls/slider)
* [Sortable Customizer Control](https://kirki.org/docs/controls/sortable)
* [Spacing Customizer Control](https://kirki.org/docs/controls/spacing)
* [Switch Customizer Control](https://kirki.org/docs/controls/switch)
* [Text Customizer Control](https://kirki.org/docs/controls/text)
* [Textarea Customizer Control](https://kirki.org/docs/controls/textarea)
* [Toggle Customizer Control](https://kirki.org/docs/controls/toggle)
* [Typography Customizer Control](https://kirki.org/docs/controls/typography)
* [Upload Customizer Control](https://kirki.org/docs/controls/upload)
2020-07-12 11:19:40 +02:00
### Theme Example ###
[Page Builder Framework](https://wp-pagebuilderframework.com?utm_source=kirki&utm_medium=repo&utm_campaign=wpbf)'s customizer settings are a prime example of what can be achieved with Kirki.
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
Conditional Logic, Partial Refresh, postMessage and a variety of controls - It has all of it.
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
### Documentation ###
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
You can find detailed documentation on how to use Kirki on [kirki.org](https://kirki.org/?utm_source=repo&utm_medium=description&utm_campaign=kirki)
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
### Kirki PRO ###
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
Kirki PRO is currently in development. You can [sign up for the waiting list](https://kirki.org/pricing/?utm_source=repo&utm_medium=description&utm_campaign=kirki) here to be notified about updates.
### Disclaimer ###
Theme developers should be familiar with the Customizer API before starting to build a theme using Kirki. An excellent handbook for the WordPress Customizer can be found on the [developer.wordpress.org](https://developer.wordpress.org/themes/customize-api/) website.
2020-03-11 14:32:45 +01:00
== Installation ==
Simply install as a normal WordPress plugin and activate.
If you want to integrate Kirki in your theme or plugin, please read the instructions on [our documentation site](https://kirki.org/docs/integration).
== Changelog ==
2020-08-10 18:52:31 +02:00
= 3.1.5 - August 10, 2020 =
2020-03-11 14:32:45 +01:00
2020-08-10 18:52:31 +02:00
* Tested up to WordPress 5.5.
* Tweak: Updated Google fonts.
* Fixed: Added wp-i18n dependency to alpha color picker script.
* Fixed: Color picker styles.
* Fixed: Color picker styles in background control.
* Fixed: Color picker styles in multicolor control.
2020-03-11 14:32:45 +01:00
2020-07-12 11:19:40 +02:00
[See the previous changelogs here](https://github.com/kirki-framework/kirki/blob/master/CHANGELOG.md).
