mirror of
https://github.com/grafana/grafana.git
synced 2024-12-28 01:41:24 -06:00
b9b42ba10f
* Add separate icons package * Update package.json * Codeformat * Use the new icon * Sanitize SVGs * Sync deps * Add publish script * Add pre-commit hook * Test pre-commit * Rename * Comment out local dev configs * Add generate action * Update readme * Update script * Add license * Rename icons to icons-generated * Codeformat * Update lerna * Remove fill attribute from SVG path elements * Revert lerna upgrade * Update codeowners * Add lint scripts * Exclude more attributes * Add missing deps * Update lockfile * Remove CI actions * Remove generated components from VC * Fix path * Build ESM only * Include cjs * Update lockfile * Move generated icons into src * Update lockfile * Sync deps with grafana * Update lockfile * Update lockfile * Update package name * Cleanup * Memoize the components * Publish esm only * Do not overwrite props * Add generate script to build * Update comment * Generate typedefs from index.ts * test * test * Restore * Add more complex icons * Add readme * Update lockfile * Make the package private * Move package exclusion to lerna.json * Remove exclusion * Revert * test packages * Fix * Fix * Revert * Move generate icons script to the root * Update script * Remove icons script * Move icons exclusion to package.json
15 lines
690 B
Markdown
15 lines
690 B
Markdown
# Grafana Saga Icons
|
|
|
|
This package contains the icon React components used in Grafana and Grafana plugins.
|
|
|
|
## Uploading a new icon
|
|
|
|
To add a new icon to the library, open a PR which adds the SVG file for the icon into the `svg` directory. The file should be named with the icon name in kebab-case. For example, if the icon name is `MyIcon`, the file should be named `my-icon.svg`. Once the PR is merged, the icon will be automatically generated and added to the library.
|
|
|
|
## Development
|
|
|
|
1. Clone the repository
|
|
2. Run `yarn install`
|
|
3. After the installation, the icon components can be found in the `src/icons-gen` directory.
|
|
4. To regenerate/update the components, run `yarn generate`.
|