Fabric React is a collection of robust React-based components designed to make it simple for you to create consistent web experiences using the Office Design Language.
+ 45 additional Microsoft sites and products
Please see the wiki.
- Using Fabric React
- Browser support
- Server-side rendering
- Advanced usage
- Contribute to Fabric React
- Building the repo
- Testing
- Advanced building tips
- Licenses
- Changelog
Here is a step by step tutorial on how to build a simple React app with an Office UI Fabric React component.
Integrating components into your project depends heavily on your setup. The recommended setup is to use a bundler such as Webpack which can resolve NPM package imports in your code and can bundle the specific things you import.
Within an npm project, you should install the package and save it as a dependency:
npm install --save office-ui-fabric-react
This will add the fabric-react project as a dependency in your package.json file, and will drop the project under node_modules/office-ui-fabric-react.
The library includes commonjs entry points under the lib folder. To use a control, you should be able to import it and use it in your render method:
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { PrimaryButton } from 'office-ui-fabric-react/lib/Button';
ReactDOM.render(<PrimaryButton>I am a button.</PrimaryButton>, document.body.firstChild);Fabric React adheres to semantic versioning. However, we only consider constructs directly importable at the package level or from files at the root (e.g. office-ui-fabric-react/lib/Utilities or office-ui-fabric-react/lib-amd/Styling) to be part of our API surface. Everything else is considered package-internal and may be subjected to changes, moves, renames, etc.
Fabric React supports all evergreen browsers, with IE 11 as the min-bar version of Internet Explorer. See the browser support doc for more information.
All components can render in LTR or RTL, depending on the dir attribute set on the html element. (dir="rtl" will flip the direction of everything.
You can also import the setRTL api to manually set it, if you don't have control over what gets renders for the html element. Example:
import { setRTL } from 'office-ui-fabric-react/lib/Utilities';
setRTL(true);If you need to render Fabric components on the server side in a node environment, there is a way to do this. The basic idea is that you need to tell the styles loader to pipe styles into a variable, which you can later use to inject into your page. Example:
import { configureLoadStyles } from '@microsoft/load-themed-styles';
// Store registered styles in a variable used later for injection.
let _allStyles = '';
// Push styles into variables for injecting later.
configureLoadStyles((styles: string) => {
_allStyles += styles;
});
import * as React from 'react';
import * as ReactDOMServer from 'react-dom/server';
import { Button } from 'office-ui-fabric-react/lib/Button';
let body = ReactDOMServer.renderToString(<Button>hello</Button>);
console.log(
`
<html>
<head>
<style>${_allStyles}</style>
</head>
<body>
${body}
</body>
</html>
`
);Note: we are evaluating a more robust theming and style loading approach, which will allow a much more flexible server rendering approach, so this syntax may be simplified in the future.
In unit or end-to-end tests that run in an SSR-like (non-browser) environment such as Node, you'll need to disable style loading.
import { initializeIcons } from 'office-ui-fabric-react/lib/Icons';
initializeIcons('dist/');
// Configure load-themed-styles to avoid registering styles.
let themeLoader = require('@microsoft/load-themed-styles');
themeLoader.configureLoadStyles(styles => {
// noop
});
// Set ssr mode to true, and rtl to false.
let library = require('office-ui-fabric-react/lib/Utilities');
library.setSSR(true);
library.setRTL(false);
// Assume a large screen.
let responsiveLib = require('office-ui-fabric-react/lib/utilities/decorators/withResponsiveMode');
responsiveLib.setResponsiveMode(responsiveLib.ResponsiveMode.large);You'll also want to mock out requiring .scss files.
In Jest:
moduleNameMapper: {
// jest-style-mock.js should just contain module.exports = {};
'\\.(scss)$': path.resolve(__dirname, 'jest-style-mock.js'),
}For advanced usage including info about module vs. path-based imports, using an AMD bundler like Require, and deployment features, see our advanced documentation.
Please take a look at our contribution guidelines for more info. Also read Contribute Bug fixes and Contribute New component.
Before you get started, make sure you have read the Git branch setup instructions
To view the documentation including examples, contracts, component status, and to add functionality or fix issues locally, you can:
git clone https://github.com/OfficeDev/office-ui-fabric-react.gitnpm installFor Windows developers, please read the next section before running thisnpm start
This will start a demo page from the office-ui-fabric-react package folder, which will open a web browser with the example page. You can make changes to the code which will automatically build and refresh the page using live-reload.
To build and run tests for all packages in the repo, you can run npm run build from the root.
To build individual packages within the packages/*/ folders, you can use npm run build in each individually. Note that because the packages are symlinked together, you must manage building dependencies in the right order, or use the rush tool to build to the specific package you want. (See advanced tips below.)
Due to a known bug in #5174, Windows developers who are using npm 6.x should downgrade to use npm v5.6.0 for now:
npm i -g npm@5.6.0
For testing see our testing documentation.
The repo contains many packages, each which may have dependencies on each other. You can use the rush tool to build projects in the correct order, if you have it globally installed.
npm install -g @microsoft/rushTo use rush to build, you can run rush build, which will incrementally build the entire repo (only build what has changed since the last build.)
To can also build up to a specific project using the --to <package> argument. For example, to build up to office-ui-fabric-react, you can run:
rush build --to office-ui-fabric-reactAll files on the Office UI Fabric React GitHub repository are subject to the MIT license. Please read the License file at the root of the project.
Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms of the assets license agreement.
We use GitHub Releases to manage our releases, including the changelog between every release. View a complete list of additions, fixes, and changes on the releases page.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
If you are getting stale[bot] messages and/or want to understand how we manage issues, please search for 'issue Triage' and/or 'stale[bot]' in the FAQ.