95 lines
5.2 KiB
Plaintext
95 lines
5.2 KiB
Plaintext
=== Kirki Customizer Framework ===
|
|
Contributors: davidvongries, aristath, dannycooper, wplemon, igmoweb
|
|
Tags: customizer, options framework, theme, mods, toolkit, gutenberg
|
|
Requires at least: 4.9
|
|
Tested up to: 5.8
|
|
Stable tag: 3.1.9
|
|
License: MIT
|
|
License URI: https://opensource.org/licenses/MIT
|
|
|
|
The ultimate customizer framework for WordPress theme developers.
|
|
|
|
== 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)
|
|
|
|
[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.
|
|
|
|
### Features ###
|
|
* Increased Performance
|
|
* Simplified API
|
|
* Automatic CSS Generation
|
|
* Automatic postMessage Generation
|
|
* Partial Refresh
|
|
* Conditional Logic
|
|
* GDPR Compliance
|
|
* Improved Page Speed
|
|
* & more!
|
|
|
|
### Controls ###
|
|
|
|
* [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)
|
|
|
|
### 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.
|
|
|
|
Conditional Logic, Partial Refresh, postMessage and a variety of controls - It has all of it.
|
|
|
|
### Documentation ###
|
|
|
|
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)
|
|
|
|
### Kirki PRO ###
|
|
|
|
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.
|
|
|
|
== 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 ==
|
|
|
|
= 3.1.9 - July 19, 2021 =
|
|
|
|
* Fixed: Styling issue in Switch control.
|
|
|
|
[See the previous changelogs here](https://github.com/kirki-framework/kirki/blob/master/CHANGELOG.md).
|