kirki-framework / field-background
Background field for the Kirki Customizer framework.
This package's canonical repository appears to be gone and the package has been frozen as a result.
Installs: 7 398
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
This package is auto-updated.
Last update: 2023-01-29 02:45:40 UTC
README
The background control is a pseudo-control for the Kirki framework. The control itself doesn't exist, it it a proxy for more basic controls. It adds controls for the following properties:
- background-color
- background-image
- background-repeat
- background-position
- background-size
- background-attachment
In addition to the above visible controls, a hidden control is added which contains the value for the sum of the above sub-controls saved as an array.
The control is only useful when using the Kirki API (which is just a proxy for the WordPress-Core Customizer API) and can not be used as-is using the customizer API directly.
If you are using the customizer-api directly, you can see what the control does by examining the code it contains in src/Field/Background.php
and extrapolating the fields you need to use directly from there.