@teamleader/ui-icons v2.9.0
Teamleader UI Icons
Interface icons used in the Teamleader application(s), both as SVG and matching React-based implementation.
Installation
Teamleader's icons package is available on npm.
$ npm install --save @teamleader/ui-icons
or
$ yarn install @teamleader/ui-icons
If you're already using teamleader-ui in your application, you can access the icons using the sub-repo notation '@teamleader-ui/icons'
.
Usage
import React from 'react';
import { render } from 'react-dom';
import { Button } from '@teamleader/ui';
import { IconWarningMediumFilled } from '@teamleader/ui-icons';
const App = () => {
return (
<Button>
<IconWarningMediumFilled />
Delete this item
</Button>
);
}
render(<App />, document.querySelector('#app'));
Development
Prerequisites
- node
^12.0.0
- npm
^6.9.0
Getting started
Clone this repo
$ git clone https://github.com/teamleadercrm/ui-icons.git
Add your newly designed SVG files to the /icons
folder. Make sure they are named properly using the dimensions_name_variant.svg
syntax, eg: 14x14_meeting_outline.svg
or 24x24_building_filled.svg
.
Don't forget to transform your newly added SVGs to React components by running
$ npm run build
How to make a release
- Pull the
master
branch to make sure you have all the latest code on your local machine. - Make a new branch, starting from
master
and give it the name of the next version you want to release (release/new.version.number
). - Bump the version in
package.json
and commit with messageVersion bump
and push. Update
CHANGELOG.md
- Replace
[unreleased]
with the[new.version.number]
and add the releasedate next to it, like this
- yyyy-mm-dd`. - Clean up the unused titles.
Prepare for next release by adding the following content on top of the file:
## [unreleased] ### Added ### Changed ### Deprecated ### Removed ### Fixed
Commit with message
Update changelog
and push.
- Replace
Make a
pull request
on Github where you add thechangelog items
as the description and wait for approval.- Make a
draft release
on Github and fill in the following fields:- Tag version:
new.version.number
@target: master
- Release title:
new.version.number
- Description: add the
changelog items
- Tag version:
- Once the pull request has the needed amount of approvals, merge it into the
master
branch. Publish
the earlier createddraft release
on Github.- In your
console
, pull themaster
branch. Publish
tonpm
using thenpm publish --access=public
command.
4 months ago
8 months ago
9 months ago
8 months ago
9 months ago
8 months ago
8 months ago
11 months ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago