Skip to content

About

OpenMoji emoji (CC-BY-SA-4.0) for the Ichava icon ecosystem.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

ichava/icon-sets-openmoji

Tests Static analysis

Two badges, not four: the pack is not on Packagist yet, so there is no registry version to show, and the artwork is CC-BY-SA 4.0 rather than MIT (the code is MIT; see License).

OpenMoji for the Ichava Laravel icon ecosystem: 8,568 SVGs in two sets, OpenMoji colour and OpenMoji black.

Requires ichava/core ^0.1 on PHP ^8.4.1 || ^8.5 and Laravel ^13.

Install

This pack requires ichava/core and nothing else. Nothing in the Ichava family is on Packagist yet, so the application's composer.json first names the repositories: core's installation guide holds the one block that lists them, core's dependencies included, and this pack's line in it is https://github.com/ichava/icon-sets-openmoji.

Then require the pack:

composer require ichava/icon-sets-openmoji

The service provider is discovered automatically. Core's installation guide covers core's own setup.

Quick start guide and usage

Getting started

Seed the pack once after installing it, and again after upgrading it:

php artisan ichava::ichava-core.database seed --package=ichava/icon-sets-openmoji

The seed is not optional: until it runs the registry holds no rows for this pack and every lookup returns nothing. No configuration is needed; the defaults are merged without publishing anything.

Usage

Icons are addressed as ichava/icon-sets-openmoji::<set>/<category>/<name>. In Blade, through core's component:

<x-ichava::icon name="ichava/icon-sets-openmoji::openmoji-color/smileys-emotion/grinning-face" class="w-6 h-6" />

Or from PHP, through core's helper:

{{ ichava('ichava/icon-sets-openmoji::openmoji-black/smileys-emotion/grinning-face')->class('w-6 h-6') }}

See Getting started for the full walkthrough, and the Documentation index below for everything else.

Documentation

The full documentation lives in this repository, under docs/, and is indexed below.

This pack

  • Installation — requirements, the repositories block, seeding
  • Getting started — your first icon from this pack
  • Configuration — this pack's config key, and what is core's instead
  • Architecture — what it ships, where the sets came from, and why
  • Release — how a version is cut, and when the core floor moves
  • Sets — the two sets, their counts, and how to address them
  • Categories — the category tree
  • Customisation — size, colour and accessibility for these emoji
  • Attribution — the CC-BY-SA terms and what they mean for you

Shared across every pack

Its upstream is OpenMoji; run core's check pack updates recipe to see whether a newer release exists.

Contributing & security

See CONTRIBUTING.md. Report vulnerabilities privately through security policy — never in a public issue.

License

Two licences apply, split by file. The package code is MIT, © Simtabi LLC, and the root LICENSE is that MIT text. The OpenMoji artwork is CC-BY-SA 4.0, and its licence text is resources/assets/svg/licenses/openmoji/LICENSE.txt.

The emoji keep that licence and Simtabi LLC claims no authorship of them. OpenMoji requires credit wherever the emoji are shown, and its share-alike term binds anything you derive from the artwork, not your application's code; the credit line and terms are in ATTRIBUTION.md, which ships with the package.

About

OpenMoji emoji (CC-BY-SA-4.0) for the Ichava icon ecosystem.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages