| Branch | Build Status |
|---|---|
| master |  |
| next |  |
Run the following command using npm:
npm install @wfp/ui
npm install @wfp/iconsor yarn:
yarn add @wfp/ui
yarn add @wfp/iconsImport a react component
import { Breadcrumb, BreadcrumbItem, BreadcrumbHome } from '@wfp/ui';Import the CSS
@import '@wfp/ui/assets/css/styles';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
-
Colors: 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 and Adobe xD library can be used to easily create new User interfaces. UI Design Kit on GitHub.
You can download it Sketch App.
Please refer to the Contribution Guidelines before starting any work.
We recommend the use of React Storybook for developing components.
- Generate new tests
$ yarn test
- Start the server:
$ yarn storybook
- Start the css watcher:
$ yarn watch:css
- Open browser to
http://localhost:9000/. - Develop components in the
/componentsfolder. - Write stories for your components in
/.storybook.