wedevelopnl/silverstripe-icon-manager

Silverstripe module to upload and manage custom icons to use in SilverStripe

4.1 2024-08-29 09:18 UTC

Requires

• php: ^8.1
• silverstripe/asset-admin: ^2.0
• silverstripe/cms: ^5
• wedevelopnl/silverstripe-svg-image: ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.20

BSD-3-Clause

• WeDevelop

• silverstripe

Published on Packagist.org on 2024-08-29 09:21 UTC

README

Upload and manage custom SVG icons across a SilverStripe site, and select them anywhere with a previewing dropdown field.

Requirements

• PHP 8.3+
• SilverStripe 6
• See composer.json for the full list

Installation

composer require wedevelopnl/silverstripe-icon-manager

Then run a dev/build. The CMS gains an Icons section where icons can be added and managed.

Further configuration

• Configuration
• Updating

License

See License

Maintainers

• WeDevelop [e-mail]

Development and contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. See CONTRIBUTING.md.

Getting started

Development runs against a throwaway SilverStripe 6 application in Docker. You need Docker and Task.

task up          # build and start the testbed, prints the URL
task test        # run every test suite
task qa          # full QA: PHPStan, Rector, coverage, lint, typecheck, build
task --list      # see everything available

The testbed's default admin login is admin / admin. Frontend assets are built with npm run build; client/dist is committed and CI verifies it matches source.