Skip to content
master
Switch branches/tags
Code

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

Build Status Code Climate License: MIT Codacy Badge Scrutinizer Code Quality

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

Theme Example

Page Builder Framework'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

Kirki PRO

Kirki PRO is currently in development. You can sign up for the waiting list 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 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.

Changelog

4.0 - November 24, 2021

  • Turn dimension fields on field-typography to look similar with other controls
  • Fix color picker on repeater control

4.0-beta.3 - November 18, 2021

Small bugfixes/changes:

  • Update googlefonts package
  • Update control-react-colorful package
  • Fix notices & warnings in module-webfonts package when get_font_choices method is called.

4.0-beta.2 - November 04, 2021

Bugfixes:

  • The CSS output of control-react-colorful was empty when the value is a string
  • On control-radio, the control id wasn't outputted causing broken behavior
  • The sanitize callback of field-dimensions wasn't implemented
  • Output on Gutenberg editing screen was affecting the whole page instead of only the editing content
  • The margin-top & margin-bottom of field-typography wasn't rendered in frontend styles
  • The kirki/fonts/standard_fonts wasn't implemented when it's hooked AFTER adding the fields (in user's usage)
  • The default browser font-family (from v3) was missing
  • The custom font families grouping was missing
  • Custom variants set on standard fonts wasn't implemented

Improvement:

  • The control-react-select choices now accept an array of objects (used by a variant in field-typography)

Refactor:

  • Bring back the v3 style/model of font's variant in field-typography

4.0-beta.1 - October 15, 2021

  • Now controls are developed (and available) as composer packages
  • Some controls are using React for their JS part
  • Much improvement over color control (using react-colorful) also includes new features
  • Improved typography field
  • Improved color palette control
  • Improved multicolor field
  • Improved dimensions field
  • Improved select controls (including dropdown pages control)
  • Some other improvements
  • Bugfixes!
  • Use Parcel as the build tool (it's nice!)

3.1.9 - July 19, 2021

  • Fixed: Styling issue in Switch control.

See the previous changelogs here.