magaziner/functions/kirki/readme.txt

88 lines
5 KiB
Text
Raw Normal View History

2020-03-11 14:44:42 +01:00
=== Kirki Customizer Framework ===
Contributors: davidvongries, aristath, dannycooper, wplemon, igmoweb
2020-03-11 14:44:42 +01:00
Tags: customizer, options framework, theme, mods, toolkit, gutenberg
2022-03-15 14:29:17 +01:00
Requires at least: 5.2
2022-05-30 10:01:01 +02:00
Tested up to: 6
Stable tag: 4.0.24
2020-03-11 14:44:42 +01:00
License: MIT
License URI: https://opensource.org/licenses/MIT
2022-05-30 10:01:01 +02:00
The Ultimate Customizer Framework for WordPress Theme Developers
2020-03-11 14:44:42 +01:00
== Description ==
[![Build Status](https://travis-ci.org/aristath/kirki.svg?branch=develop)](https://travis-ci.org/aristath/kirki) [![Code Climate](https://codeclimate.com/github/aristath/kirki/badges/gpa.svg)](https://codeclimate.com/github/aristath/kirki) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/66d6d8b6a4654cd18686ed1cd9f1bfb3)](https://www.codacy.com/app/aristath/kirki?utm_source=github.com&utm_medium=referral&utm_content=aristath/kirki&utm_campaign=Badge_Grade) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/aristath/kirki/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/aristath/kirki/?branch=develop)
2022-05-30 10:01:01 +02:00
**NEW - [Kirki PRO](https://kirki.org/extensions/?utm_source=repo&utm_medium=description&utm_campaign=kirki) is now available!**
[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:44:42 +01:00
2022-05-30 10:01:01 +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:44:42 +01:00
2022-05-30 10:01:01 +02:00
### Controls 🎛️ ###
2020-03-11 14:44:42 +01:00
* [Background Customizer Control](https://kirki.org/docs/controls/background)
* [Code Customizer Control](https://kirki.org/docs/controls/code)
2022-03-15 14:29:17 +01:00
* [Checkbox Customizer Control](https://kirki.org/docs/controls/checkbox)
2020-03-11 14:44:42 +01:00
* [Color Customizer Control](https://kirki.org/docs/controls/color)
2022-03-15 14:29:17 +01:00
* [Color Palette Customizer Control](https://kirki.org/docs/controls/color-palette)
2020-03-11 14:44:42 +01:00
* [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)
2022-03-15 14:29:17 +01:00
* [Dimension Customizer Control](https://kirki.org/docs/controls/dimension)
* [Dimensions Customizer Control](https://kirki.org/docs/controls/dimensions)
2020-03-11 14:44:42 +01:00
* [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)
2022-03-15 14:29:17 +01:00
* [Radio Customizer Control](https://kirki.org/docs/controls/radio)
2020-03-11 14:44:42 +01:00
* [Radio Buttonset Customizer Control](https://kirki.org/docs/controls/radio-buttonset)
* [Radio Image Customizer Control](https://kirki.org/docs/controls/radio-image)
* [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)
* [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)
2022-05-30 10:01:01 +02:00
### Kirki PRO Extensions 🏆 ###
Create the WordPress experience your customers deserve with [Kirki PRO Extensions](https://kirki.org/extensions/?utm_source=repo&utm_medium=description&utm_campaign=kirki).
2020-03-11 14:44:42 +01:00
2022-05-30 10:01:01 +02:00
## PRO Features ##
* Tabs
* Responsive Controls
* Input Slider
* Headlines & Dividers
* Margin & Padding Controls
2020-03-11 14:44:42 +01:00
2022-05-30 10:01:01 +02:00
Learn more about [Kirki PRO](https://kirki.org/extensions/?utm_source=repo&utm_medium=description&utm_campaign=kirki).
2020-03-11 14:44:42 +01:00
2022-05-30 10:01:01 +02:00
### 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)
2020-03-11 14:44:42 +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 ==
2022-03-15 14:29:17 +01:00
[See the changelogs here](https://github.com/kirki-framework/kirki/blob/master/CHANGELOG.md).