app-icons-test

1.0.13 • Public • Published

DXP ICONS

Single source of truth for DXP icons.

Changelog

[3.0.0]

  • start to use new icons for V3

[2.0.44]

  • add my-community-languages-schools-program

[2.0.42]

  • add my-etam, my-qplus

[2.0.39]

  • add my-rbnsw

[2.0.38]

  • add my-i-work-for-nsw

[2.0.37]

  • add my-success-factors

[2.0.35]

  • add my-scan

[2.0.34]

  • fix my-training-services-rvp
  • add my-urh

[2.0.32]

  • added my-online-learning-tools-marketplace

[2.0.31]

  • added my-tele-counselling

[2.0.30]

  • added my-skills-broker

[2.0.29]

  • added my-ssms

[2.0.28]

  • added my-staff-mail-upgrade again

[2.0.27]

  • added my-recruitment-beyond-nsw

[2.0.26]

  • added my-training-services-wfd-salesforce, my-training-services-rvp

[2.0.25]

  • added my-saap

###[2.0.24]

  • added my-rural-gap-access and my-training-services-wfd-salesforce

[2.0.23]

  • added my-covid-vaccine-self-attestation and my-covid-vaccine-confirmation

[2.0.22]

  • added my-staff-mail-upgrade

[2.0.21]

  • added my-ttss

[2.0.20]

  • added my-aware-super, my-class-cover, my-salary-package, my-school-stream, and my-wwcc

[2.0.19]

  • added my-canva-for-education

[2.0.18]

  • added my-professional-learning, my-attendance-matters, and my-perfect-presence

[2.0.17]

  • added my-dart

[2.0.16]

  • added my-pes

[2.0.15]

  • changed my-tree-safety, my-sinsw-fm-web, and my-sinsw-fm-survey background color

[2.0.14]

  • Added my-qtm

[2.0.13]

  • Added my-tree-safety, my-sinsw-fm-web, my-sinsw-fm-survey, my-sinsw-online-portal

[2.0.12]

  • Added my-scholastic-learning-zone

[2.0.11]

  • Added app code mapping for VDL: my-school-digital-logbook

[2.0.10]

  • Added my-accelerated-reader

[2.0.9]

  • Added my-pei

[2.0.8]

  • Added my-school-bytes

[2.0.7]

  • Added my-school-digital-logbook

[2.0.6]

  • Added my-renaissance

[2.0.5]

  • Updated my-digitallearningselector icon

[2.0.4]

  • Changed my-ssi background colour

[2.0.3]

  • Added my-ssi

[2.0.2]

  • Added my-dlrh

[2.0.1]

  • Added my-inoffice

[2.0.0]

  • Create bash script to automate part of the process to insert new icons
  • Update background-colours

[1.0.40]

  • Added my-staff-noticeboard

[1.0.39]

  • Added my-statewide-staffrooms
  • Added my-dart-connections

[1.0.38]

  • Added my-school-sports-unit
  • Added my-t4l-professional-learning-events

[1.0.37]

  • Added my-t4l-podcast
  • Added my-t4l-magazine

[1.0.36]

  • updated my-nsw-gov

[1.0.35]

  • Added my-itd-roadmap
  • Added my-sre

[1.0.34]

  • Added my-oscr
  • updated my-HPEG

[1.0.33]

  • Added my-HPEG
  • Updated my-erg

[1.0.32]

  • Added my-adobe-cc
  • Added my-corporate-learning-center

[1.0.31]

  • Added my-emh
  • update nsw-gov

[1.0.30]

  • Added my-ci-checklist

[1.0.29]

  • Added my-seia-resources

[1.0.28]

  • Added my-erg. Updated my-atso, my-plnts, my-sps and my-t4l.

[1.0.27]

  • added my-t4l

[1.0.26]

  • rollback compiled svgs because some apps referencing non 'my-' prefixed elements.

[1.0.25]

  • recompiled svgs with app id suffixes to fix duplicate id accessiblitiy issues

[1.0.24]

  • added my-plnts
  • added my-evaluation-resource-hub

[1.0.23]

  • added my-terminal
  • added my-mma
  • added my-atso

[1.0.22]

  • added my-lifelauncher
  • added my-zoom

[1.0.21]

  • added my-dei
  • added my-digitallearningselector

[1.0.20]

  • added my-sentral
  • added my-worldbookonline

[1.0.19]

  • updated my-sps
  • added my-yau

[1.0.18]

  • added my-sps

[1.0.17]

  • added my-scost

[1.0.16]

  • added json to support iOS

[1.0.17]

  • added my-sap-fiori

[1.0.14]

  • updated my-alan, added my-perf-dev-non-teaching-staff

[1.0.13]

  • added my-being-well, my-perf-dev-corporate-staff, my-teacher-performance-development

[1.0.12]

  • added my-csaw, my-linkedin-training, my-learning-hub

[1.0.9]

  • added my-edbay, my-bookboon

[1.0.8]

  • added my-dls, nsw-gov logo

[1.0.7]

  • added my-cas

[1.0.6]

  • fix dup ids

[1.0.5]

  • added my-alan, my-known-valued-cared, my-msa, my-sharepoint, my-ictplus icons
  • update icon page to use relative paths to always show latest icons

[1.0.4]

  • added my-master-schedule, my-my-future, and my-school-centric-delivery icons

[1.0.3]

  • updated Scout icon

Related Resources

Application Icons svg: https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/sprite.svg

Map between application and background colour css classes: https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/essentialIconsMap.js

CSS file with css classes for app icon colours: https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/essentialColours.css

Map between application codes (from db) and svg icon ids https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/essentialIconCodesMap.js

Icons insertion

The process to insert a new icon must follow these steps:

  1. Add the icon's PDF version into PDFs folder. Filename must be the icon's name (lowercase separated by dashes).

  2. Add the icon's SVG version into SVGs folder. Filename must be the icon's name (lowercase separated by dashes).

  3. Add the icon's name and colour into the essentialIconsMap.json. The data must be inserted following the template:

     {
       ...,
       "my-<icon-name>": "essentials-<icon-colour>"
     }
    
  4. From the root directory, run the command:

     npm run build
    

Testing locally

You will need to serve the iconsheet page from a local web server so that the related js, css and svg files can be served to the page when requested.

With python installed, run the following command from the iconsheet folder:

    npm run test

Then go to 'http://localhost:8000' in your web browser.

Icons deployment

Icons are deployed via npm. Before publishing a new version:

  1. Update the version number in package.json.

      npm version <update-type>
    

Update types can be "major", "minor", or "patch".

     1.2.3 = major.minor.patch

The update type for adding new icons usually is "patch".

  1. Update the version numbers referenced in this readme with a message about the change.

  2. If it is the first time, you need to login to your npm account with:

     npm login
    
  3. Then the new version can be published:

     npm publish --access public
    

Once published, tag the published commit (in git) with the version number.

The published files are accessed via jsdelivr:

https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/sprite.svg https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/essentialIconsMap.js https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/essentialColours.css https://cdn.jsdelivr.net/npm/@nswdoe/app-icons@latest/essentialIconCodes.js

The icon map page is deployed via npm.

The list of apps to display is derived from the object keys in essentialIconsMap.js.

Readme

Keywords

none

Package Sidebar

Install

npm i app-icons-test

Weekly Downloads

0

Version

1.0.13

License

ISC

Unpacked Size

2.48 MB

Total Files

15

Last publish

Collaborators

  • chrisy99