themeum/kirki
Stars: 1255
Forks: 323
Pull Requests: 581
Issues: 1935
Watchers: 66
Last Updated: 2023-09-16 17:55:48
Extending the customizer
License: MIT License
Languages: JavaScript, PHP, Shell, CSS, SCSS, Batchfile, TypeScript, HTML
Kirki Customizer Framework
Contributors: [themeum] Tags: customizer, options framework, theme, mods, toolkit, gutenberg Requires at least: 5.2 Tested up to: 6.2.2 Stable tag: 5.0.0 License: MIT License URI: https://opensource.org/licenses/MIT
The ultimate customizer framework for WordPress theme developers.
Description
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
- Code Customizer Control
- Checkbox Customizer Control
- Color Customizer Control
- Color Palette Customizer Control
- Dashicons Customizer Control
- Date Customizer Control
- Dimension Customizer Control
- Dimensions Customizer Control
- Dropdown Pages Customizer Control
- Editor Customizer Control
- Generic Customizer Control
- Image Customizer Control
- Link Customizer Control
- Multiple Checkbox Customizer Control
- Multicolor Customizer Control
- Number Customizer Control
- Radio Customizer Control
- Radio Buttonset Customizer Control
- Radio Image Customizer Control
- Repeater Customizer Control
- Select Customizer Control
- Slider Customizer Control
- Sortable Customizer Control
- Switch Customizer Control
- Text Customizer Control
- Textarea Customizer Control
- Toggle Customizer Control
- Typography Customizer Control
- Upload Customizer Control
Documentation
You can find detailed documentation on how to use Kirki on themeum.com
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
OPEN ISSUES
See all- Allow using `required` in panels & sections by @aristath
- Example of using post_meta, i.e page custom css by @pingram3541
- Show/hide fields inside a repeater using 'active_callback' by @rahulv3a
- what about adding numeric or slider controls in the repeater fields ? by @michellomp
- Extension point for repeater fields by @ghost
- add multiple image uploader by @michellomp
- Using `kirki/{$config_id}/styles` filter with widgets by @rahulv3a
- Change Preview URL when sections expanded by @daviedR
- Possible to add instant preview ( js_vars ) to repeatable fields group? by @fakrulislam
- Add a new action in the repeater fields to allow adding custom control types. by @aristath
- Adding Collapsible Controls by @LWS-Web
- Symlink Issues by @coleh33
- The field-dependencies JS implementation doesn't work by @aristath
- allow using pattern_replace for media queries by @aristath
- function => html no longer works for js_vars by @aristath
- Multicolor - Ability to utilize value_pattern by @bawright
- Customize Color Picker Palette by @bawright
- Refactoring repeaters. by @aristath
- Type: Typography → How to make changes/modifications by @fastmarketo
- Modifying new fields of repeater field in existing rows doesn't work by @ArekZw
- Add responsive length control by @aristath
- Refactor typography control by @aristath
- When a repeater field is opened, can it be auto-closed once another repeater is opened? by @AlxMedia
- Generic icon field instead of just dashicons by @ghost
- Add docs for i18n by @aristath
- Support for fontawesome, slider and dashicons controls in repeater by @FairWindCo
- Choose any variant but only load the chosen ones by @kevinmamaqi
- Select field is not working in Expanded sections by @rahulv3a
- Google Fonts load twice by @imthat
- Adding Multiple Variants Using Typography Field . by @medabkari
- Add ability to limit characters in text and textarea fields by @dannycolin
- Changing the Date control date format by @VladNov
- `border-width` and `border-radius` are not working properly with the `dimensions` field by @rahulv3a
- Panel priorities don't work in nested Panels by @rahulv3a
- Multiple css properties output on a single color? by @wp-kitten
- We need to reconsider how CSS variables work with Kirki by @rahulv3a
- Migrate checkboxes in kirki.input.js by @aristath
- Active callback for selected preview device? by @reefki
- Fix URLs when kirki is installed in a subfolder in mu-plugins. by @aristath
- PostMessage + Typography empty default by @anthonyryanrusso
- Test v4.0 with WP 4.9.x by @aristath
- control-base package: Check if we can remove some of the object properties by @aristath
- Deprecate the dynamic-control.js script by @aristath
- Check styling of color-palette controls by @aristath
- Date control: switch to a format like the one use in wp-core by @aristath
- Combine multicheck & sortable fields by @aristath
- Improve styling of palette controls by @aristath
- Allow initing select options from AJAX or other JS var by @aristath
- Split data implementations by @aristath
- Refactor the Values class by @aristath
- Go through all packages and check the package.json dependencies. by @aristath
- url-getter module: Find a way to handle symlinks by @aristath
- Docs change for font-style in typography fields. by @aristath
- Update typography subsets by @DannyCooper
- Conflict with the Gutenberg plugin by @aristath
- Preloaded custom variants of google font by @vlthemes
- 'active_callback' not working on 'type' => 'custom', by @ravishakya
- Hide 'Add Media' button in editor control by @crn1
- Feature request: Google font preview in typography dropdown by @binaryfire
- active_callback not work when 'option_type' => 'option', - with fix by @mtaman
- 'code' not working on 'preset' by @fabriguespe
- Repeater - new field does not work by @congthien
- How to translate text fields in WPML or Polylang? by @BeholdPL
- active_callback with || not, && by @BeholdPL
- How to use multicolor colors in color-palette automatically? by @BeholdPL
- repeater control by @sauravxtha
- How to use CSS variables in Typography control? by @BeholdPL
- Kirki issue with repeater. by @aalimran07
- Transport : Auto Issue (v 3.1.9) by @scottstanford
- Field order is not working correctly by @plazorax
- Output CSS are not generated when using `option` mode by @daviedR
- PHP error and Customize is not working by @mukhtar-88
- Fonts are not properly loaded by @DeoThemes
- WordPress 4.9/ClassicPress compatibility by @ghost
- Kirki is making my websites crash by @jesse-uilenreef
- Thank you for this awesome plugin, But I could not solve font-face src's URLs problem by @ali-han
- Warning: Undefined variable $args by @hfittipaldi
- Select Control doesn't work with ZERO values by @Oxibug
- Allowing same 'settings' value multiple times by @phlangf
- CSS Output is not applied in pattern library by @JiveDig
- Bug with typo control by @vlthemes
- Multicolor not working with Preset by @idlevibes95
- no support for custom plugin directory by @wibed
- Exclude confusion - how to exclude if element has ANY value by @codejp3
- Fatal error when upgrade to php 8 environment by @nouarah-kh
- Create million files in tmp by @gribchenko
- Mixed content error on post editing pages (admin) by @luis-movel
- Fatal error: Uncaught Error: Call to undefined method CSCO_Kirki::active_callback() by @tianth
- No reset/empty option in select control by @x-bull
- Repeater control not showing up in customizer by @valenjeb
- Install individual packages with Composer Kirki v.4.1.0 by @111RK
- Issues setting default swatches/palettes by @oobi
- Loading Kirki via composer messes with other plugins/classes by @JiveDig
- Fields under tabs don't appear correctly with 'active_callback' by @artkrsk
- Pushing to WordPress w/o Changelog by @stacksize
- Multiple Select fields in a Repeater field don't appear correctly by @irisinteractive
- Using a 'contains' active callback when compare values is of type int, creates a hidden warning in css block. by @sebastianthulin
- The Dimensions field does not keep the default choices by @irisinteractive
- PHP 8.2 deprecation notices by @plazorax
- Customizer doesnt work. Syntax error. by @hackthedev
RELEASES
See all- 4.2.0 by @kawshar
- 4.1.0 by @contactjavas
- 4.0.24 by @contactjavas
- 4.0.23 by @contactjavas
- 4.0.22 by @contactjavas
- 4.0.21 by @contactjavas
- 4.0.20 by @contactjavas
- 4.0.19 by @contactjavas
- 4.0.18 by @contactjavas
- 4.0.16 by @contactjavas
- 4.0.15 by @contactjavas
- 4.0.14 by @contactjavas
- 4.0.13 by @contactjavas
- 4.0.3 by @contactjavas
- 4.0.1 by @contactjavas
- 4.0 by @contactjavas
- 4.0-beta.3 by @contactjavas
- 4.0-beta.2 by @contactjavas
- 4.0-beta.1 by @contactjavas
- 3.1.9 by @MapSteps
- 3.1.8 by @MapSteps
- 3.1.7 by @MapSteps
- 3.1.6 by @MapSteps
- 3.1.5 by @MapSteps
- 3.1.4 by @MapSteps
- Version 3.1.2 by @aristath
- Version 3.1.1 by @aristath
- Version 3.1.0 by @aristath
- Version 3.0.45 by @aristath
- Version 3.0.44 by @aristath
- Version 3.0.43 by @aristath
- Version 3.0.42 by @aristath
- Version 3.0.41 by @aristath
- Version 3.0.40 by @aristath
- Version 3.0.39 by @aristath
- Version 3.0.38 by @aristath
- Version 3.0.37 by @aristath
- Version 3.0.36 by @aristath
- Version 3.0.36-beta.2 by @aristath
- Version 3.0.36-beta.1 by @aristath
- Version 3.0.35.3 by @aristath
- Version 3.0.35.2 by @aristath
- Version 3.0.35.1 by @aristath
- Version 3.0.35 by @aristath
- Version 3.0.34 by @aristath
- Version 3.0.33 by @aristath
- Version 3.0.32 by @aristath
- Version 3.0.31 by @aristath
- Version 3.0.30 by @aristath
- Version 3.0.29 by @aristath
- Version 3.0.28 by @aristath
- 3.0.27 by @aristath
- 3.0.26 by @aristath
- Version 3.0.25 by @aristath
- Version 3.0.24 by @aristath
- Version 3.0.23 by @aristath
- Version 3.0.22 by @aristath
- Version 3.0.21 by @aristath
- Version 3.0.20 by @aristath
- Version 3.0.19 by @aristath
- Version 3.0.18 by @aristath
- Version 3.0.17 by @aristath
- Version 3.0.16 by @aristath
- Version 3.0.15 by @aristath
- Version 3.0.14 by @aristath
- Version 3.0.13 by @aristath
- Version 3.0.12 by @aristath
- Version 3.0.11 by @aristath
- Version 3.0.10 by @aristath
- Version 3.0.10-beta.1 by @aristath
- Version 3.0.9 by @aristath
- Version 3.0.8 by @aristath
- Version 3.0.7 by @aristath
- Version 3.0.6 by @aristath
- Version 3.0.5 by @aristath
- Version 3.0.4 by @aristath
- Version 3.0.3 by @aristath
- Version 3.0.2 by @aristath
- Version 3.0.1 by @aristath
- Version 3.0.0 by @aristath
- Version 3.0.0-beta.2 by @aristath
- Version 2.3.8 by @aristath
- Version 2.4.0-beta.2 by @aristath
- Version 2.4.0-beta.1 by @aristath
- Version 2.3.7 by @aristath
- Version 2.3.6 by @aristath
- Version 2.3.5 by @aristath
- Version 2.3.4 by @aristath
- Version 2.3.3 by @aristath
- Version 2.3.2 by @aristath
- Version 2.3.1 by @aristath
- Version 2.3.0 by @aristath
- Version 2.2.10 by @aristath
- Version 2.2.9 by @aristath
- 2.2.8 by @aristath
- 2.2.7 by @aristath
- 2.2.6 by @aristath
- 2.2.5 by @aristath
- Version 2.2.4 by @aristath
- Version 2.2.3 by @aristath