Skip to content

Commit 0b0df50

Browse files
authored
Update Fabric website to "Fluent" (microsoft#12366)
1 parent 40c445f commit 0b0df50

File tree

164 files changed

+616
-287
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+616
-287
lines changed

.github/ISSUE_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Note that if you do not provide enough information to reproduce the issue, we ma
3131
<!--
3232
Providing an isolated reproduction of the bug in a codepen makes it much easier for us to help you. Here are some ways to get started:
3333
34-
* Go to https://aka.ms/fabricpen for a starter codepen
34+
* Go to https://aka.ms/fluentpen for a starter codepen
3535
* You can also use the "Export to Codepen" feature for the various components in our documentation site.
3636
* See http://codepen.io/dzearing/pens/public/?grid_type=list for a variety of examples
3737
38-
Alternatively, you can also use https://aka.ms/fabricdemo to get permanent repro links if the repro occurs with an example.
38+
Alternatively, you can also use https://aka.ms/fluentdemo to get permanent repro links if the repro occurs with an example.
3939
(A permanent link is preferable to "use the website" as the website can change.)
4040
-->
4141

.github/ISSUE_TEMPLATE/accessibility_issue.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Issues that do not meet these guidelines will be closed.
3434
<!--
3535
Providing an isolated reproduction of the issue in a codepen makes it much easier for us to help you. Here are some ways to get started:
3636
37-
* Go to https://aka.ms/fabricpen for a starter codepen
37+
* Go to https://aka.ms/fluentpen for a starter codepen
3838
* You can also use the "Export to Codepen" feature for the various components in our documentation site.
3939
* See http://codepen.io/dzearing/pens/public/?grid_type=list for a variety of examples
4040
41-
Alternatively, you can also use https://aka.ms/fabricdemo to get permanent repro links if the repro occurs with an example.
41+
Alternatively, you can also use https://aka.ms/fluentdemo to get permanent repro links if the repro occurs with an example.
4242
(A permanent link is preferable to "use the website" as the website can change.)
4343
-->
4444

.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Note that if you do not provide enough information to reproduce the issue, we ma
2424
<!--
2525
Providing an isolated reproduction of the bug in a codepen makes it much easier for us to help you. Here are some ways to get started:
2626
27-
* Go to https://aka.ms/fabricpen for a starter codepen
27+
* Go to https://aka.ms/fluentpen for a starter codepen
2828
* You can also use the "Export to Codepen" feature for the various components in our documentation site.
2929
* See http://codepen.io/dzearing/pens/public/?grid_type=list for a variety of examples
3030
31-
Alternatively, you can also use https://aka.ms/fabricdemo to get permanent repro links if the repro occurs with an example.
31+
Alternatively, you can also use https://aka.ms/fluentdemo to get permanent repro links if the repro occurs with an example.
3232
(A permanent link is preferable to "use the website" as the website can change.)
3333
-->
3434

LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Office UI Fabric React
1+
Fluent UI React
22

33
Copyright (c) Microsoft Corporation
44

@@ -12,4 +12,4 @@ The above copyright notice and this permission notice shall be included in all c
1212

1313
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1414

15-
Note: Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms listed at https://aka.ms/fabric-assets-license
15+
Note: Usage of the fonts and icons referenced in Fluent UI React is subject to the terms listed at https://aka.ms/fluentui-assets-license

README.md

+19-20
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@ We have a lot in store for Fluent UI - [Read our announcement here.](https://dev
1010

1111
[![npm version](https://badge.fury.io/js/office-ui-fabric-react.svg)](https://badge.fury.io/js/office-ui-fabric-react) [![Build Status](https://uifabric.visualstudio.com/fabricpublic/_apis/build/status/office-ui-fabric-react%20-%20PR?branchName=master)](https://uifabric.visualstudio.com/fabricpublic/_build/latest?definitionId=84&branchName=master)
1212

13+
Fluent UI React is a collection of robust React-based components designed to make it simple for you to create consistent web experiences using the Fluent Design Language.
1314

14-
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.
15-
16-
## Who uses UI Fabric?
15+
## Who uses Fluent UI React?
1716

1817
![image](https://user-images.githubusercontent.com/785361/50458071-45b58d00-0915-11e9-90c0-ad8789c99db5.png)
1918

@@ -25,26 +24,26 @@ Please see the [wiki](https://github.com/microsoft/fluentui/wiki).
2524

2625
## Contents
2726

28-
- [Using Fabric React](#using-fabric-react)
27+
- [Using Fluent UI React](#using-fluent-ui-react)
2928
- [Starter apps](#starter-apps)
3029
- [Integrating in your project](#integrating-in-your-project)
3130
- [Version policy](#version-policy)
3231
- [Browser support](#browser-support)
3332
- [Right-to-left support](#right-to-left-support)
3433
- [Server-side rendering](#server-side-rendering)
3534
- [Advanced usage](#advanced-usage)
36-
- [Contribute to Fabric React](#contribute-to-fabric-react)
35+
- [Contribute to Fluent UI React](#contribute-to-fluent-ui-react)
3736
- [Building the repo](#building-the-repo)
3837
- [Testing](#testing)
3938
- [Advanced building tips](#advanced-building-tips)
4039
- [Licenses](#licenses)
4140
- [Changelog](#changelog)
4241

43-
## Using Fabric React
42+
## Using Fluent UI React
4443

4544
### Starter apps
4645

47-
To create a simple starter app using Fabric components, [install the latest LTS node.js](https://nodejs.org), then run:
46+
To create a simple starter app using Fluent UI components, [install the latest LTS node.js](https://nodejs.org), then run:
4847

4948
```
5049
npm init uifabric
@@ -68,51 +67,51 @@ How to integrate components into your project depends heavily on your setup. The
6867
Within an npm project, you should install the package and save it as a dependency:
6968

7069
```
71-
npm i office-ui-fabric-react
70+
npm i @fluentui/react
7271
7372
# Or, use yarn
74-
yarn add office-ui-fabric-react
73+
yarn add @fluentui/react
7574
```
7675

77-
This will add the package as a dependency in your `package.json` file and download it under `node_modules/office-ui-fabric-react`.
76+
This will add the package as a dependency in your `package.json` file and download it under `node_modules/@fluentui/react`.
7877

7978
The library includes ES2015 module entry points under the `lib` folder (use `lib-amd` if you need AMD, or `lib-commonjs` if you need commonjs). To use a control, import it and then use it in your render method:
8079

8180
```js
8281
import React from 'react';
8382
import ReactDOM from 'react-dom';
84-
import { PrimaryButton } from 'office-ui-fabric-react/lib/Button';
83+
import { PrimaryButton } from '@fluentui/react/lib/Button';
8584

8685
ReactDOM.render(<PrimaryButton>I am a button.</PrimaryButton>, document.getElementById('root'));
8786
```
8887

8988
### Version policy
9089

91-
Fabric React adheres to [semantic versioning](http://www.semver.org/). 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 subject to changes, moves, renames, etc.
90+
Fluent UI React adheres to [semantic versioning](http://www.semver.org/). However, we only consider constructs directly importable at the package level or from files at the root (e.g. `@fluentui/react/lib/Utilities` or `@fluentui/react/lib-amd/Styling`) to be part of our API surface. Everything else is considered package-internal and may be subject to changes, moves, renames, etc.
9291

9392
### Browser support
9493

95-
Fabric React supports all evergreen browsers, with IE 11 as the min-bar version of Internet Explorer. See the [browser support doc](https://github.com/microsoft/fluentui/wiki/Browser-Support) for more information.
94+
Fluent UI React supports all evergreen browsers, with IE 11 as the min-bar version of Internet Explorer. See the [browser support doc](https://github.com/microsoft/fluentui/wiki/Browser-Support) for more information.
9695

9796
### Right-to-left support
9897

9998
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 use the `setRTL` API if you don't have control over the `html` element's rendering. Example:
10099

101100
```tsx
102-
import { setRTL } from 'office-ui-fabric-react/lib/Utilities';
101+
import { setRTL } from '@fluentui/react/lib/Utilities';
103102

104103
setRTL(true);
105104
```
106105

107106
### Server-side rendering
108107

109-
Fabric components can be rendered in a server-side Node environment (or used in tests which run in an SSR-like environment), but it requires customizing how styles and SCSS files are loaded. See the [server-side rendering documentation](https://github.com/microsoft/fluentui/wiki/Server-side-rendering-and-browserless-testing) for examples of how to handle this.
108+
Fluent UI React components can be rendered in a server-side Node environment (or used in tests which run in an SSR-like environment), but it requires customizing how styles and SCSS files are loaded. See the [server-side rendering documentation](https://github.com/microsoft/fluentui/wiki/Server-side-rendering-and-browserless-testing) for examples of how to handle this.
110109

111110
### Advanced usage
112111

113112
For info about advanced usage including module- vs. path-based imports, using an AMD bundler like RequireJS, and deployment features, see our [advanced documentation](https://github.com/microsoft/fluentui/wiki/Advanced-Usage).
114113

115-
## Contribute to Fabric React
114+
## Contribute to Fluent UI React
116115

117116
Please take a look at our [contribution guidelines](https://github.com/microsoft/fluentui/wiki/Contributing) for more info. Also read [Contribute bug fixes](https://github.com/microsoft/fluentui/wiki/Bug-Fixes) and [Contribute new component](https://github.com/microsoft/fluentui/wiki/New-Components).
118117

@@ -123,12 +122,12 @@ Before you get started, **make sure you have read the [Git branch setup instruct
123122
To view the documentation including examples, contracts, component status, and to add functionality or fix issues locally, you can:
124123

125124
1. `git clone https://github.com/microsoft/fluentui.git`
126-
2. `cd office-ui-fabric-react`
125+
2. `cd fluentui`
127126
3. `yarn`
128127
4. `yarn builddemo`
129128
5. `yarn start`
130129

131-
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.
130+
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.
132131

133132
To build and run tests for all packages in the repo, run `yarn build` from the root.
134133

@@ -144,9 +143,9 @@ For info about testing, see our [testing documentation](https://github.com/micro
144143

145144
## Licenses
146145

147-
All 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.
146+
All files on the Fluent UI React GitHub repository are subject to the MIT license. Please read the License file at the root of the project.
148147

149-
Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms of the [assets license agreement](https://aka.ms/fabric-assets-license).
148+
Usage of the fonts and icons referenced in Fluent UI React React is subject to the terms of the [assets license agreement](https://aka.ms/fluentui-assets-license).
150149

151150
## Changelog
152151

apps/fabric-website-resources/LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Office UI Fabric React
1+
Fluent UI
22

33
Copyright (c) Microsoft Corporation
44

@@ -12,4 +12,4 @@ The above copyright notice and this permission notice shall be included in all c
1212

1313
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1414

15-
Note: Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms listed at https://aka.ms/fabric-assets-license
15+
Note: Usage of the fonts and icons referenced in Fluent UI React is subject to the terms listed at https://aka.ms/fluentui-assets-license
+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# @uifabric/fabric-website-resources
22

3-
**Local demo app for office-ui-fabric-react controls**
3+
**Local demo app for @fluentui/react controls**
44

5-
This package contains the demo app that runs when you do `yarn start` from the root of the Fabric repo or from the `office-ui-fabric-react` package.
5+
This package contains the demo app that runs when you do `yarn start` from the root of the Fluent UI repo or from the `office-ui-fabric-react` package.
66

7-
To see a live version of this app, go to https://aka.ms/fabricdemo and choose a version.
7+
To see a live version of this app, go to https://aka.ms/fluentdemo and choose a version.
88

9-
See the [readme](https://github.com/microsoft/fluentui) for more information about Fabric and instructions for getting started with development, including how to run this app locally.
9+
See the [readme](https://github.com/microsoft/fluentui) for more information about Fluent UI and instructions for getting started with development, including how to run this app locally.

apps/fabric-website-resources/src/docs/GettingStartedOverview.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Overview
22

3-
Fabric React components are built as production-ready, generalized, documented, and reusable components to be used in Microsoft products. This enables us and our partners to more easily build great applications without spending a ton of time implementing the same things over and over.
3+
Fluent UI React components are built as production-ready, generalized, documented, and reusable components to be used in Microsoft products. This enables us and our partners to more easily build great applications without spending a ton of time implementing the same things over and over.
44

55
Each component is designed to be RTL-friendly, keyboard accessible, screen reader-friendly, themeable, and generalized. TypeScript definition files are also included, so if you use TypeScript (which isn't a requirement), you will get compiler validation and using an editor like VS Code, you'll get intellisense. Each component is exported as a named module that can be easily imported in your code, allowing your external bundler to create small bundles that include just what you need.
66

@@ -11,18 +11,17 @@ Integrating components into your project depends heavily on your setup. The reco
1111
Within an npm project, you should install the package and save it as a dependency:
1212

1313
```bash
14-
npm install --save office-ui-fabric-react
14+
npm install --save @fluentui/react
1515
```
1616

17-
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.
17+
This will add the `@fluentui/react` project as a dependency in your package.json file, and will drop the project under `node_modules/@fluentui/react`.
1818

19-
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. Note that wrapping your application in the Fabric component is required to support RTL, keyboard focus and other features.
19+
The library includes commonjs entry points under the `lib-commonjs` folder. To use a control, you should be able to import it and use it in your render method. Note that wrapping your application in the `<Fabric>` component is required to support RTL, keyboard focus and other features.
2020

2121
```tsx
2222
import * as React from 'react';
2323
import * as ReactDOM from 'react-dom';
24-
import { Fabric } from 'office-ui-fabric-react/lib/Fabric';
25-
import { DefaultButton } from 'office-ui-fabric-react/lib/Button';
24+
import { Fabric, DefaultButton } from '@fluentui/react';
2625

2726
const MyPage = () => (
2827
<Fabric>
@@ -38,15 +37,15 @@ ReactDOM.render(<MyPage />, document.body.firstChild);
3837
While it is possible to import all components as named imports from the main module entry point, it is not recommended to do so without using a bundler that supports es6 tree shaking. In other words, if you import the Button component like this:
3938

4039
```tsx
41-
import { Button } from 'office-ui-fabric-react';
40+
import { Button } from '@fluentui/react';
4241
```
4342

4443
...this would work, but then unless you are using a tree-shaking bundler such as Rollup.js or Webpack 2, Webpack will assume you want every module exported from the main entry file to be included in your final bundle, which produces unnecessary large bundles and slows your page load down. Instead you can import the specific paths to trim down your bundle size:
4544

4645
```tsx
47-
import { Button } from 'office-ui-fabric-react/lib/Button';
48-
import { Dropdown } from 'office-ui-fabric-react/lib/Dropdown';
49-
import { List } from 'office-ui-fabric-react/lib/List';
46+
import { Button } from '@fluentui/react/lib/Button';
47+
import { Dropdown } from '@fluentui/react/lib/Dropdown';
48+
import { List } from '@fluentui/react/lib/List';
5049
```
5150

5251
## Using an AMD bundler like r.js

apps/fabric-website/LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Office UI Fabric React
1+
Fluent UI
22

33
Copyright (c) Microsoft Corporation
44

@@ -12,4 +12,4 @@ The above copyright notice and this permission notice shall be included in all c
1212

1313
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1414

15-
Note: Usage of the fonts referenced on Office UI Fabric files is subject to the terms listed at https://aka.ms/fabric-assets-license
15+
Note: Usage of the fonts referenced on Fluent UI files is subject to the terms listed at https://aka.ms/fluentui-assets-license

apps/fabric-website/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# [Fabric website](https://dev.microsoft.com/fabric)
1+
# [Fluent UI website](https://dev.microsoft.com/fabric)
22

3-
**The official website for the UI Fabric project.**
3+
**The official website for the Fluent UI project.**
44

5-
UI Fabric is a collection of projects that represent the Fluent design language in code. This website helps document the components and styles that make up Fabric.
5+
Fluent UI is a collection of projects that represent the Fluent design language in code. This website helps document the components and styles that make up Fluent UI.
66

77
## Build the website
88

9-
See the [readme](https://github.com/microsoft/fluentui) for instructions on getting started with Fabric development.
9+
See the [readme](https://github.com/microsoft/fluentui) for instructions on getting started with Fluent UI development.
1010

1111
Once your repo is set up, run the following to start a local copy of the website. (Be sure to **start from the root of the repo**, not the `fabric-website` folder.)
1212

apps/fabric-website/Third Party Notices.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
4646

4747
------------
4848

49-
Office UI Fabric
49+
Fluent UI
5050

5151
Copyright (c) Microsoft Corporation
5252

@@ -59,4 +59,4 @@ The above copyright notice and this permission notice shall be included in all c
5959

6060
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
6161

62-
Note: Usage of the fonts referenced on Office UI Fabric files is subject to the terms listed at https://aka.ms/fabric-assets-license
62+
Note: Usage of the fonts referenced on Fluent UI files is subject to the terms listed at https://aka.ms/fluentui-assets-license

0 commit comments

Comments
 (0)