-
Notifications
You must be signed in to change notification settings - Fork 2.9k
docs: establish multi-framework design system structure #36692
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Mariano Gutiérrez Xavier (marianog-ms)
wants to merge
2
commits into
microsoft:master
Choose a base branch
from
marianog-ms:marianog-ms-design-system-repo-structure
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+86
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Design system repository structure | ||
|
|
||
| Fluent UI supports multiple delivery models in one repository. The repository | ||
| is the source of truth for shared design tokens, accessibility requirements, | ||
| component behavior, and documentation. Each framework integration owns its | ||
| runtime and packaging details. | ||
|
|
||
| ## Integration boundaries | ||
|
|
||
| | Integration | Location | Consumer | | ||
| | --- | --- | --- | | ||
| | Shared tokens | `packages/tokens/` | All integrations | | ||
| | React components | `packages/react-components/` | React applications | | ||
| | Flask/Jinja integration | `packages/flask-ui/` | Flask applications | | ||
|
|
||
| The existing React packages remain unchanged. The Flask package is currently a | ||
| private scaffold so its API can be designed without prematurely publishing an | ||
| incomplete package. | ||
|
|
||
| ## Branch and repository policy | ||
|
|
||
| Use one repository and short-lived feature branches. Do not maintain permanent | ||
| framework branches: they drift, make shared token changes harder to review, and | ||
| prevent one pull request from showing the complete cross-framework impact. | ||
|
|
||
| Use a separate repository only if an integration requires different access | ||
| controls, release ownership, or a substantially different contribution | ||
| workflow. A separate repository should still consume the shared token contract | ||
| and publish compatibility documentation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Fluent UI Flask integration | ||
|
|
||
| This package is the Flask/Jinja integration surface for the Fluent UI design | ||
| system. It is intentionally private while the integration contract is being | ||
| defined. | ||
|
|
||
| ## Scope | ||
|
|
||
| - Jinja macros and templates for server-rendered applications | ||
| - CSS custom properties generated from the shared Fluent token source | ||
| - Accessibility and interaction guidance shared with the React implementation | ||
|
|
||
| The package must not duplicate design tokens. Token names and values are owned | ||
| by `@fluentui/tokens`; Flask assets should consume the generated token output. | ||
|
|
||
| ## Planned layout | ||
|
|
||
| ```text | ||
| packages/flask-ui/ | ||
| ├── templates/ # Jinja macros and base templates | ||
| ├── static/ # Generated CSS and other browser assets | ||
| └── README.md | ||
| ``` | ||
|
|
||
| React consumers continue to use the existing `@fluentui/react-components` | ||
| package. Both integrations share the token source and design documentation, | ||
| but they can evolve and release independently. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "name": "@fluentui/flask-ui", | ||
| "version": "0.0.0", | ||
| "description": "Fluent UI integration points for Flask and Jinja applications", | ||
| "private": true, | ||
| "license": "MIT", | ||
| "files": [ | ||
| "templates", | ||
| "README.md" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Flask templates | ||
|
|
||
| Jinja templates and macros will be added here once the server-rendered | ||
| component contract is approved. Keep templates framework-specific and consume | ||
| generated Fluent design tokens rather than defining a second token system. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🕵🏾♀️ visual changes to review in the Visual Change Report
vr-tests-react-components/Menu Converged - submenuIndicator slotted content 2 screenshots
vr-tests-react-components/Positioning 2 screenshots
vr-tests-react-components/ProgressBar converged 3 screenshots
vr-tests-react-components/TagPicker 3 screenshots
vr-tests-web-components/Accordion 1 screenshots
vr-tests-web-components/Avatar 1 screenshots
vr-tests-web-components/Badge 1 screenshots
vr-tests-web-components/MenuList 1 screenshots
vr-tests/Callout 9 screenshots
vr-tests/Keytip 1 screenshots
vr-tests/react-charting-AreaChart 1 screenshots
vr-tests/react-charting-LineChart 3 screenshots
There were 4 duplicate changes discarded. Check the build logs for more information.