Skip to content

Commit e76134a

Browse files
jurokapsiarJuraj Kapsiarkhmakoto
authored
Add more v9 information to README and to northstar docs (#25332)
* Add more v9 information to README and to northstar docs * fix * Update packages/fluentui/README.md Co-authored-by: Makoto Morimoto <[email protected]> * feedback * doctoc Co-authored-by: Juraj Kapsiar <[email protected]> Co-authored-by: Makoto Morimoto <[email protected]>
1 parent 6ced976 commit e76134a

File tree

3 files changed

+42
-30
lines changed

3 files changed

+42
-30
lines changed

README.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,33 @@
66
77
Fluent UI web represents a collection of utilities, React components, and web components for building web applications.
88

9-
This repo is home to 3 separate projects today. Mixing components between projects is not currently supported. The goal of these projects is to dedupe functionality and enable interoperability over time. For now, choose the project that best suits your needs.
9+
This repo is home to 3 separate projects today. Combining Fluent UI React v9 components with Fluent UI React v8 or v0 components is possible and allows gradual migration to Fluent UI v9.
1010

1111
The following table will help you navigate the 3 projects and understand their differences.
1212

1313
<!-- prettier-ignore-start -->
14-
| | React | React Northstar | Web Components |
14+
| | React Components (v9) | React (v8) | Web Components |
1515
|---| ----- | --------------- | -------------- |
16-
| **Overview** | Mature, refreshing with new concepts from react-northstar. | Newer, has concepts we're iterating on. | Web Component implementation of Fluent UI. |
17-
| **Used By** | Office| Teams | Edge |
18-
| **Read Me** | [README.md](/packages/react/README.md) | [README.md](/packages/fluentui/README.md) | [README.md](/packages/web-components/README.md) |
19-
| **Changelog** | [CHANGELOG.md](/packages/react/CHANGELOG.md) | [CHANGELOG.md](/packages/fluentui/CHANGELOG.md) | [CHANGELOG.md](/packages/web-components/CHANGELOG.md) |
20-
| **Repo** | [./packages/react](/packages/react) | [./packages/fluentui/react-northstar](/packages/fluentui/react-northstar) | [./packages/web-components](/packages/web-components) |
21-
| **Quick Start** | [Quick Start](https://developer.microsoft.com/en-us/fluentui#/get-started/web) | [Quick Start](https://fluentsite.z22.web.core.windows.net/quick-start) | [See README.md](https://github.com/microsoft/fluentui/tree/master/packages/web-components/README.md) |
22-
| **Docs** | [aka.ms/fluentui-react](https://aka.ms/fluentui-react) | [aka.ms/fluentui-react-northstar](https://aka.ms/fluentui-react-northstar) | [aka.ms/fluentui-web-components](https://aka.ms/fluentui-web-components) |
23-
| **NPM** | `@fluentui/react` | `@fluentui/react-northstar` | `@fluentui/web-components` |
24-
| **Version** | [![npm version](https://img.shields.io/npm/v/@fluentui/react?style=flat-square)](https://www.npmjs.com/package/@fluentui/react) | [![npm version](https://img.shields.io/npm/v/@fluentui/react-northstar?style=flat-square)](https://www.npmjs.com/package/@fluentui/react-northstar) | [![npm version](https://img.shields.io/npm/v/@fluentui/web-components?style=flat-square)](https://www.npmjs.com/package/@fluentui/web-components) |
25-
| **Issues** | [![Fluent UI React GitHub Issues](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react%20(v8)?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react+(v8)%22) | [![Fluent UI React Northstar GitHub Issues](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react-northstar?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react-northstar%22) | [![Fluent UI Web Components GitHub Issues](https://img.shields.io/github/issues/microsoft/fluentui/web-components?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22web-components%22) |
16+
| **Overview** | New, future-proof and forward looking | Mature | Web Component implementation of Fluent UI. |
17+
| **Used By** | Microsoft 365 | Office | Edge |
18+
| **Read Me** | [README.md](/packages/react-components/react-components/README.md) | [README.md](/packages/react/README.md)| [README.md](/packages/web-components/README.md) |
19+
| **Changelog** | [CHANGELOG.md](/packages/react-components/react-components/CHANGELOG.md) | [CHANGELOG.md](/packages/react/CHANGELOG.md) | [CHANGELOG.md](/packages/web-components/CHANGELOG.md) |
20+
| **Repo** | [packages/react-components](/packages/react-components/react-components/CHANGELOG.md) | [./packages/react](/packages/react) | [./packages/web-components](/packages/web-components) |
21+
| **Quick Start** | [Quick Start](https://react.fluentui.dev/?path=/docs/concepts-developer-quick-start--page) | [Quick Start](https://developer.microsoft.com/en-us/fluentui#/get-started/web) | [See README.md](https://github.com/microsoft/fluentui/tree/master/packages/web-components/README.md) |
22+
| **Docs** | [https://react.fluentui.dev/](https://react.fluentui.dev/) | [aka.ms/fluentui-react](https://aka.ms/fluentui-react) | [aka.ms/fluentui-web-components](https://aka.ms/fluentui-web-components) |
23+
| **NPM** | `@fluentui/react-components` | `@fluentui/react`| `@fluentui/web-components` |
24+
| **Version** | [![npm version](https://img.shields.io/npm/v/@fluentui/react-components?style=flat-square)](https://www.npmjs.com/package/@fluentui/react-components) | [![npm version](https://img.shields.io/npm/v/@fluentui/react?style=flat-square)](https://www.npmjs.com/package/@fluentui/react) | [![npm version](https://img.shields.io/npm/v/@fluentui/web-components?style=flat-square)](https://www.npmjs.com/package/@fluentui/web-components) |
25+
| **Issues** | [![Fluent UI React Components GitHub Issues](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react-components?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react-components+%28v9%29%22) | [![Fluent UI React GitHub Issues](https://img.shields.io/github/issues/microsoft/fluentui/Fluent%20UI%20react%20(v8)?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react+(v8)%22) | [![Fluent UI Web Components GitHub Issues](https://img.shields.io/github/issues/microsoft/fluentui/web-components?label=issues&style=flat-square)](https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22web-components%22) |
2626
<!-- prettier-ignore-end -->
2727

28-
> Why are there two React versions? See the [FAQ on Fabric and Stardust](https://github.com/microsoft/fluentui/wiki/FAQ---Fabric-and-Stardust-to-Fluent-UI).
28+
> Why are there two React versions? Fluent UI v8 is still widely used. We encourage you to migrate to Fluent UI v9. See the [Migration overview](https://react.fluentui.dev/?path=/docs/concepts-migration-overview--page).
2929
3030
## FluentUI Insights
3131

3232
[Fluent UI Insights](https://docs.microsoft.com/en-us/shows/fluent-ui-insights?utm_source=github) is a series that describes the design and decisions behind the Fluent UI design system.
3333

34-
| EP01: Positioning | EP02: Styling | EP03: Griffel |
35-
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
34+
| EP01: Positioning | EP02: Styling | EP03: Griffel |
35+
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
3636
| <a href="https://learn.microsoft.com/en-us/shows/fluent-ui-insights/fluent-ui-insights-positioning?utm_source=github" target="_blank"><img src="ghdocs/medias/fluentui-ep01-preview.gif" alt="Watch EP01: Positioning" width="240" /></a> | <a href="https://learn.microsoft.com/en-us/shows/fluent-ui-insights/fluent-ui-insights-styling?utm_source=github" target="_blank"><img src="ghdocs/medias/fluentui-ep02-preview.gif" alt="Watch EP02: Styling" width="240" /></a> | <a href="https://learn.microsoft.com/en-us/shows/fluent-ui-insights/fluent-ui-insights-griffel?utm_source=github" target="_blank"><img src="ghdocs/medias/fluentui-ep03-preview.gif" alt="Watch EP03: Griffel" width="240" /></a> |
3737

3838
## Licenses
@@ -53,6 +53,10 @@ The `office-ui-fabric-react` repo is now this repo (`fluentui` in the Microsoft
5353

5454
We have a lot in store for Fluent UI - [Read our announcement here.](https://developer.microsoft.com/en-us/office/blogs/ui-fabric-is-evolving-into-fluent-ui/)
5555

56+
## Looking for Fluent UI React Northstar?
57+
58+
Fluent UI React Northstar has been superseded by Fluent UI React Components v9. For more details about Fluent UI React Northstar, see its [README.md](/packages/fluentui/README.md).
59+
5660
---
5761

5862
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

packages/fluentui/README.md

+19-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Fluent UI - React Northstar ([docs](https://aka.ms/fluent-ui))
22

3-
This is the new home for `@fluentui/react-northstar` and related packages which were migrated from the [`microsoft/fluent-ui-react` repo][1].
3+
[![npm version](https://img.shields.io/npm/v/@fluentui/react-northstar?style=flat-square)](https://www.npmjs.com/package/@fluentui/react-northstar)
4+
5+
This is the home for `@fluentui/react-northstar` and related packages which were migrated from the [`microsoft/fluent-ui-react` repo][1].
6+
7+
**Status**
8+
9+
Fluent UI React Northstar has been superseded by Fluent UI React Components v9. For more details about migration to Fluent UI React Components v9, see [Migration documentation][5].
10+
11+
**Versioning**
412

513
> Since the `@fluentui/react-northstar` packages are on version 0.x, note that:
614
>
@@ -16,8 +24,8 @@ This is the new home for `@fluentui/react-northstar` and related packages which
1624
- [Issues](#issues)
1725
- [Documentation and usage examples](#documentation-and-usage-examples)
1826
- [FAQs](#faqs)
19-
- [Why the move?](#why-the-move)
20-
- [Why the separate folder?](#why-the-separate-folder)
27+
- [What is the future of Fluent UI React Northstar?](#what-is-the-future-of-fluent-ui-react-northstar)
28+
- [How can we migrate to Fluent UI React Components v9?](#how-can-we-migrate-to-fluent-ui-react-components-v9)
2129
- [What's happening with Teams support?](#whats-happening-with-teams-support)
2230

2331
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -29,25 +37,28 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for a step-by-step setup and development
2937
## Issues
3038

3139
If you need to [file an issue][3], please note in the title or description that it refers to `@fluentui/react-northstar`.
40+
List of [active issues][4]
3241

3342
## Documentation and usage examples
3443

3544
See the doc site at https://aka.ms/fluent-ui.
3645

3746
## FAQs
3847

39-
### Why the move?
48+
### What is the future of Fluent UI React Northstar?
4049

41-
We're in the process of converging UI projects at Microsoft under the "Fluent UI" banner to simplify the dev story. In the process, we're making performance improvements and enabling greater interoperability of these components across more places and platforms at Microsoft.
50+
The future of `@fluentui/react-northstar` is called `@fluentui/react-components`. It builds on top of many base principles that were present in Northstar, streamlines the API and brings significantly improved performance.
4251

43-
### Why the separate folder?
52+
### How can we migrate to Fluent UI React Components v9?
4453

45-
These packages remain in a separate folder while we work on converging the build systems and certain other details, but they will eventually move directly under `packages` (or `apps`) next to the other packages.
54+
Please see the [Migration documentation][5].
4655

4756
### What's happening with Teams support?
4857

49-
`@fluentui/react-northstar v0.x.x` (formerly `@fluentui/react v0.x.x`) has been the official set of components for Teams. This is still the case and no support is being dropped.
58+
`@fluentui/react-northstar v0.x.x` (formerly `@fluentui/react v0.x.x`) has been the official set of components for Teams. This is still the case and no support is being dropped. New features will only be added to Fluent UI React Components v9.
5059

5160
[1]: https://github.com/microsoft/fluent-ui-react
5261
[2]: https://github.com/microsoft/fluentui/blob/master/packages/fluentui/CHANGELOG.md
5362
[3]: https://github.com/microsoft/fluentui/issues/new/choose
63+
[4]: https://github.com/microsoft/fluentui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Fluent+UI+react-northstar+%28v0%29%22
64+
[5]: https://react.fluentui.dev/?path=/docs/concepts-migration-overview--page

packages/fluentui/docs/src/views/Introduction.tsx

+4-7
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ const Introduction = () => (
3434
Fluent UI provides extensible vanilla JavaScript solutions to component state, styling, and accessibility. These
3535
powerful features are exposed behind simple APIs based on natural language.
3636
</p>
37+
38+
<h3>Status</h3>
3739
<p>
38-
Fluent UI React is being built as an exemplar of the Fluent UI design language, component specifications, and
39-
utilities.
40+
Fluent UI React Northstar has been superseded by{' '}
41+
<Link to="https://react.fluentui.dev/">Fluent UI React Components v9</Link>.
4042
</p>
4143

4244
<h3>Learn</h3>
@@ -48,11 +50,6 @@ const Introduction = () => (
4850
<p>
4951
If you want to get going right away, see the <NavLink to="quick-start">Quick Start</NavLink> guide.
5052
</p>
51-
52-
<h3>Fluent UI React V9</h3>
53-
<p>
54-
This is our latest and more performant library, <Link to="https://react.fluentui.dev/">link to docs</Link>.
55-
</p>
5653
</div>
5754
);
5855

0 commit comments

Comments
 (0)