Giter VIP home page Giter VIP logo

ui-icons's Introduction

Warning

This package is deprecated. The content is moved to the @teamleader/ahoy package. The further development of the project will be closed-source but the package will be published under the new name.

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

  1. Pull the master branch to make sure you have all the latest code on your local machine.

  2. Make a new branch, starting from master and give it the name of the next version you want to release (release/new.version.number).

  3. Bump the version in package.json and commit with message Version bump and push.

  4. Update CHANGELOG.md

    • Replace [unreleased] with the [new.version.number] and add the release date 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.

  5. Make a pull request on Github where you add the changelog items as the description and wait for approval.

  6. 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
  7. Once the pull request has the needed amount of approvals, merge it into the master branch.

  8. Publish the earlier created draft release on Github.

  9. In your console, pull the master branch.

  10. Publish to npm using the npm publish --access=public command.

ui-icons's People

Contributors

arnaudweyts avatar beirlaenaaron avatar dependabot-preview[bot] avatar dependabot[bot] avatar driesd avatar eniskraasniqi1 avatar eosullivanberlin avatar farazatarodi avatar instak avatar jdc-teamleader avatar jelledc avatar jorensaeytl avatar kemosabert avatar kevinwaelkens avatar kristofcolpaert avatar lennertblommaert avatar lorgan3 avatar lowiebenoot avatar mikeverf avatar mrtus avatar nickwaelkens avatar qubis741 avatar sanderbrugge avatar stephen-tl avatar svenlombaert avatar taraldrotsaert avatar teamleader-iac[bot] avatar timdegroote avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ui-icons's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/create-tag.yaml
  • peter-murray/workflow-application-token-action v2
  • actions/checkout v4
  • rickstaa/action-contains-tag v1
  • softprops/action-gh-release v1
  • mikepenz/release-changelog-builder-action v4.0.0
  • softprops/action-gh-release v1

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.