refactor: finish stardust to fluent rename #2165
Conversation
levithomason
requested review from
dvdzkwsk,
dzearing,
ecraig12345,
JasonGore,
jdhuntington,
kenotron,
layershifter,
miroslavstastny and
mnajdova
as code owners
levithomason
changed the title
.github/CONTRIBUTING.md
Outdated
| @@ -25,7 +26,7 @@ | |||
|
|
|||
| Make sure you have [Node.js][1] version v8 or later installed. | |||
|
|
|||
| You can contribute to Stardust by being an official [contributor](setup-local-development.md#contributors) or without permissions, as a [collaborator](setup-local-development.md#collaborators) | |||
| You can contribute to FluentUI by being an official [contributor](setup-local-development.md#contributors) or without permissions, as a [collaborator](setup-local-development.md#collaborators) | |||
There was a problem hiding this comment.
Curious of the reasoning for using FluentUI rather than Fluent UI? I know that more directly matches the scope name, but I thought the lack of a dash in the scope name was just an unfortunate artifact of fluent-ui being taken already.
There was a problem hiding this comment.
Per Joseph McLaughlin, they got a lot of feedback on the FluentUi initial idea and they changed the official guidance. It is now officially Fluent UI. 👍
He said he'd make an official announcement to the internal team today. Not sure if it happened yet. I do have the design guidance PDF if you'd like a copy 😄
levithomason
force-pushed
the
docs/rename-to-fluent
branch
from
320a73a
to
b53e84f
Compare
| import { WithAsProp, withSafeTypeForAs } from '../../types' | ||
|
|
||
| export interface ProviderBoxProps | ||
| extends UIComponentProps<ProviderBoxProps>, | ||
| ContentComponentProps, | ||
| ChildrenComponentProps {} | ||
|
|
||
| const ProviderBox = createComponent<WithAsProp<ProviderBoxProps>>({ | ||
| const ProviderBox = createComponentPrivate<WithAsProp<ProviderBoxProps>>({ |
There was a problem hiding this comment.
| const ProviderBox = createComponentPrivate<WithAsProp<ProviderBoxProps>>({ | |
| const ProviderBox = createComponentInternal<WithAsProp<ProviderBoxProps>>({ |
| className = 'ui-stardust-component', | ||
| const createComponentPrivate = <P extends ObjectOf<any> = any>({ | ||
| displayName = 'FluentComponent', | ||
| className = 'fluent-ui-component', |
| 'stardust-pause': themeIcons['pause'], | ||
| 'stardust-play': themeIcons['play'], | ||
| 'icon-checkmark': themeIcons['accept'], | ||
| 'icon-circle': themeIcons['icon-circle'], |
There was a problem hiding this comment.
Not sure I understand this line
There was a problem hiding this comment.
Looks like this is a teams theme icon literally named iconCircle.
See packages/react/src/themes/teams/components/Icon/svg/icons/iconCircle.tsx
Breaking Changes
This PR only renames "Stardust UI" to "Fluent UI", including all variants. No other changes were made.
createComponent()render()callback param key fromstardusttoconfig:import { createComponent } from '@fluentui/react' createComponent({ - render({ stardust }) => {}, + render({ config }) => {}, })CreateStardustComponentConfigtoCreateComponentConfig.RenderStardustResultConfigtoCreateComponentRenderConfig.classNameof the returned component fromui-stardust-componenttofluent-ui-component.💡 The
displayNameof the returned component was renamed fromStardustComponenttoFluentUIComponent. It is unlikely that your code relied on thisdisplayNamebut we're including it here for completeness.Theme
StardustAnimationNametyping toAnimationName.stardust-*toicon-*:const myTheme: ThemePrepared = createTheme({ ... icons: { - 'stardust-checkmark': { isSvg: boolean, icon: SvgIconSpec }, + 'icon-checkmark': { isSvg: boolean, icon: SvgIconSpec }, ... }, 'my-theme')Debug
✏️ Rename
window.localStorage.stardustDebugtowindow.localStorage.fluentUIDebug, if you had enabled debug.This PR finishes the work by renaming Stardust references to Fluent UI. We've renamed the repo and packages. We've also published the docs and packages under the new Fluent UI and
@fluentuiname.