@teliads/pictograms
v1.1.1
Published
Vocads pictograms library
Downloads
5,905
Keywords
Readme
Pictograms
This package contains the "raw" svg pictograms, that can be used for instance in the telia-pictogram
component. It also contains tooling to convert these icons to source code that can be imported and used in your project. The source code is generally based on the raw svg files, and therefore it is not a good idea to change any of the generated source code files manually.
Adding, removing or updating pictograms
If we receive new pictogram svg:s or updated pictogram svg:s of existing pictograms proceed as follows:
- Put the new/updated pictogram
./assets/
(not in./src/assets/
!) - Run
yarn build
This will re-create the generated source code and therefore also update the actual pictograms.
Removing picrograms is a destructive action that needs to be considered carefully. If an pictogram is removed, it may cause problems for teams who are using that pictogram. Removing an pictogram needs a migration plan. These live in the documentation/
directory of this repository and in the packages/components/src/documentation/
directory. There is information on the Storybook page. (TODO: add link to new storybook site.)
Technically, removing an pictogram only requires you to remove it from ./assets/
and run yarn build
.
Source code that is not generated
In the ./src/
directory,
- utils/
- global.d.ts
are not generated. These files are either used during the generation of source code, or a part of the dist of this package.