Download the PHP package rasteiner/k3-awesome-picker without Composer

On this page you can find all versions of the php package rasteiner/k3-awesome-picker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of rasteiner/k3-awesome-picker

Informations about the package k3-awesome-picker

Show and pick a free Font Awesome icon.

Install

Download Zip file

Copy plugin folder into site/plugins

Composer

Run composer require rasteiner/k3-awesome-picker.

Usage

Add an icon field to your blueprint. You can also choose to filter the available icons by declaring the wanted styles: brands (Logos), solid (filled icons), regular (outlined icons)

In your template you will get the class names for the chosen icon.

Example

Blueprint:

Template:

Config options

Under the rasteiner.awesome-picker namespace, you'll have access to the following options:

option default description
'css-url' 'https://kit-free.fontawesome.com/releases/latest/css/free.min.css' Used in the panel, the URL to the font awesome CSS
'meta-source' 'github' File path, or function returning the file path, to the "icons.yml" file containing all metadata of the icons. The default setting of 'github' downloads the metadata from github on first usage, then it stores the file on the server
'sprites-folder' false Useful when using the SVG setup (see below). Path, or function returning the path, to the sprites folder
'default-styles' ["solid", "regular", "brands", "light", "duotone"] Array or string for which styles should be available when the styles setting in your blueprint isn't used
'loaded-styles' ["solid", "regular", "brands", "light", "duotone"] Array or string for which styles should ever be available for use

SVG setup

If you prefer having your icons embedded in your page and use them via SVG links, this plugin offers you a way to manage this, but you need to prepare it for the use case.

  1. Download your icons
    Font Awesome gives you the option to download their icons. Download the "web" version from here: https://fontawesome.com/download. Unzip the file and upload it to your server.

  2. Configure the plugin
    The plugin needs to know 3 things:

    1. The URL to the CSS file with all classes you intend to use (this is used only for the panel, you'll find them in the css folder you downloaded)
    2. The file path to the metadata of your icons (you'll find this in the "metadata" folder, look for an "icons.yml" file)
    3. The file path to the folder containing the sprite sheets (this is the "sprites" folder)

    Here's an example config:

    You can assign all those config options either a string, or a function that returns a string.

  3. Adapt the templates
    Linked svg icons need 2 steps to work:

    1. Use the icons, via the <use xlink:href="#icon-id"> tag
    2. Embed all used icons in the page, via many <symbol id="icon-id"> tags

    This plugin offers you some functions to help you do this, it tracks which icons have been used, and then injects all used items as symbols. To do this, you'll use the following methods:

    1. the $field->toIcon() field method. This gives you an "Icon" object
    2. the $icon->use($attrs) method of the Icon object, this gives you an svg element containing a corresponding <use> tag. This method optionally lets you specify the attributes given to the <svg> tag.
    3. the $site->iconSymbols() method which generates an svg element containing all previously used icons as <symbol> elements.

    Here's a short example template:

    This will output something like this:

    Notice: you need to call $site->iconSymbols() after all $icon->use() calls. So either put the symbols at the end of the page, or output buffer your page.

All versions of k3-awesome-picker with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rasteiner/k3-awesome-picker contains the following files

Loading the files please wait ....