| Branch | Build Status |
|---|---|
| master | |
| v1.5 |
Run the following command using npm:
npm install @wfp/ui
npm install @wfp/iconsor yarn:
yarn add @wfp/ui
yarn add @wfp/iconsFor v1.19.0 or higher, install sass instead of node-sass
Import a react component
import { Breadcrumb, BreadcrumbItem, BreadcrumbHome } from '@wfp/ui';Import the CSS
import '@wfp/ui/assets/css/styles.css';Additional information about the Usage can be found here.
View available Components here. Usage information is available when you click the blue Show Info icon in the top right corner of the selected component.
The new WFP UI Kit is based on the World Food Programme’s Branding Guidance WFP's new branding was launched in early 2018 and will be implemented across the organization, strengthening WFP’s brand image through consistent representation.
Building on this initiative, the World Food Programme’s User Interface Style Guide emphasizes WFP’s commitment to establish and build the brand.
The purpose of this project is to create a unified toolkit that is used by UX-designers and developers alike on their projects to ensure all WFP-branded projects are accessible, appealing, and have a consistent look and feel across the board by following WFP’s design and implementation guidelines.
The guidelines contained in this guide are to be applied to all WFP digital products (such as: websites, web applications, internal systems and other).
By unifiying design elements into reusable components, development will simplify and accelerate the development of these digital products.
The Guide is a living document created to meet the needs of WFP’s front-end developers and designers. If there is a Component or Pattern that you need, or you have any other feedback, question or comment please contact us.
The UI Kit is based on:
All the logo files can be found in the UI Assets repository on GitHub.
Currently the logo is available in
- Colours: blue, white and black
- Fileformat: svg, png in different sizes
- Languages: arabic, english, spanish, french
The Source files can be found in https://github.com/wfp/ui-assets.
All the logo files can be found in https://github.com/wfp/ui-assets.
The Sketch App and Adobe xD library can be used to easily create new User interfaces.
The downloads are available here: UI Design Kit on GitHub.
Please refer to the Contribution Guidelines before starting any work.
Use the feat/ branches for active development.
We recommend the use of React Storybook for developing components.
- Generate new tests
npm run test
- Start the server:
npm run storybook
- Open browser to
http://localhost:9000/. - Develop components in the
/componentsfolder. Add the export toindex.jsto include them into the build. - Write stories for your components in
/.componentswith.stories.jsorstories.mdxending.
Use Conventional Commits for commit messages and pre-commit hooks for commiting.
Make sure your commit does not produce any errors while checking:
- ESlint
- jest tests
- correct commit message
Use jest for testing the components. Once commited the branches will be also tested on Travis CI.
npm run test
The UI Kit uses Azure Devops and semantic-release for automate versioning and CHANGELOG generation.
- Commits on the
masterbranch will be released as@lastestif a relevant commit is included (e.g. feat, fix, perf, breaking) - Commits on
nextbranch will be released as@nextif a relevant commit is included
npm run release -- --prerelease alpha
npm publish --tag alpha
or
git push --follow-tags origin next && npm publish --tag alpha
npm run release
npm publish
Create a new build for the documentation and copy the assets and docs folder manually to WFP`s AWS S3 instance following the naming scheme (for example: v1.2.1).
npm run build:storybook
Edit the website-redirect-location meta tag of index.html to point wfp.org/UIGuide to the latest documentation folder. This can be done with MountainDuck.
Edit the first line of assets/depreciation-warning.html to point to the latest version of the UI Kit.
Clear the Server cache with Cloudfront Purge Tool.