Download the PHP package mindkomm/theme-lib-icons without Composer

On this page you can find all versions of the php package mindkomm/theme-lib-icons. 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 mindkomm/theme-lib-icons

Informations about the package theme-lib-icons

Icons

Collection of icon sprite helper functions for WordPress themes.

Installation

You can install the package via Composer:

Functions

Name Summary Type Returns/Description
get_icon Get an icon string The HTML to be used in a template.
get_icon_url Get the URI to the icon sprite. string The URI to the icon sprite. Default build/icons/icons.svg
get_svg_icon Return HTML for an accessible SVG icon in an icon sprite. string The HTML to be used in a template.
prepare_html_tag_attribute Turn a value and a name into an HTML attribute. string

get_icon

Get an icon

This function is a wrapper that makes it easier to include an icon by only providing the name of the icon and not the whole path. By adding this function, it’s also possible to use the theme version constant for cache busting.

get_icon( string $icon_name, string $width, string $height, array $args = [] )

Returns: string The HTML to be used in a template.

Name Type Description
$icon_name string The slug of the icon.
$width string Width in pixel the icon should be displayed at.
$height string Height in pixel the icon should be displayed at.
$args array Optional. Array of arguments for SVG icon. See get_svg_icon() function.

PHP

get_svg_icon

Return HTML for an accessible SVG icon in an icon sprite.

Has the possibility to add a description for the icon to provide better accessibility.

get_svg_icon( string $path, string $width = '', string $height = '', array $args = [] )

Returns: string The HTML to be used in a template.

Name Type Description
$path string Absolute URL to the icon in an icon sprite.
$width string Width in pixel the icon should be displayed at.
$height string Height in pixel the icon should be displayed at.
$args array Optional. Array of arguments for SVG icon.

  • $class
    string Class names for the SVG icon.
  • $id
    string ID of the SVG icon.
  • $description
    string Description of the icon for better accessibility. Don’t describe the icon, but describe what it means.

PHP

prepare_html_tag_attribute

Turn a value and a name into an HTML attribute.

prepare_html_tag_attribute( string $value = '', string $name = '' )

Returns: string

Name Type Description
$value string The value to use.
$name string The attribute’s name.

get_icon_url

Get the URI to the icon sprite.

Returns: string The URI to the icon sprite. Default build/icons/icons.svg

Filters

get_icon_url

The default location for the icon sprite is build/icons/icons.svg. If you’ve set up your theme with a different folder structure, you can use the get_icon_url filter to use a different URL throughout this library:

Twig Functions

You need Timber to use this.

icon

Shorthand function for get_icon().

Support

This is a library that we use at MIND to develop WordPress themes. You’re free to use it, but currently, we don’t provide any support.

All versions of theme-lib-icons with dependencies

PHP Build Version
Package Version
Requires mindkomm/theme-lib-mix Version ^1.0.0
php Version >=7.0.0
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 mindkomm/theme-lib-icons contains the following files

Loading the files please wait ....