-
Notifications
You must be signed in to change notification settings - Fork 3
Progress component RFC #10
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
lukewarlow
wants to merge
1
commit into
openui:main
Choose a base branch
from
lukewarlow:rfcs/progress
base: main
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.
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| * Start Date: 2025-02-24 | ||
| * RFC PR: (Leave empty till PR Created) | ||
|
|
||
| ## Summary | ||
|
|
||
| This RFC proposes the addition of a Progress component to the Open UI Design System. Progress components are used to represent the completion status of a task or process. | ||
|
|
||
| # Basic Example | ||
|
|
||
| ```html | ||
| <!-- Determinate Example --> | ||
| <label for="progress">Example Label:</label> | ||
| <oui-progress id="progress" value="20" max="100"></oui-progress> | ||
|
|
||
| <!-- Indeterminate Example --> | ||
| <label for="indeterminate-progress">Example Label:</label> | ||
| <oui-progress id="indeterminate-progress"></oui-progress> | ||
| ``` | ||
|
|
||
| # Motivation | ||
|
|
||
| Progress indicators are a common UI pattern used to communicate the status of a task or process to users. By providing a Progress component in the Open UI Design System, we can ensure a consistent and accessible implementation across applications. | ||
|
|
||
| # Detailed Proposal | ||
|
|
||
| The `oui-progress` component will provide a versatile, accessible, and themable implementation of progress indicators. The component will support both determinate and indeterminate modes. | ||
|
|
||
| ## API | ||
|
|
||
| This component will be form associated so it can be labeled by a `<label>` element. | ||
|
|
||
| ### CSS States | ||
|
|
||
| | State | Description | | ||
| |-------|-------------| | ||
| | `indeterminate` | The progress bar is in an indeterminate state. | | ||
|
|
||
| ### CSS Parts | ||
|
|
||
| | Part | Description | | ||
| |---------|--------------------------------------------| | ||
| | `track` | The track for the progress bar. | | ||
| | `fill` | The filled in portion of the progress bar. | | ||
|
|
||
| ### Properties | ||
|
|
||
| | Property | Type | Default | Readonly | Description | | ||
| |----------|------|---------|-------------| | ||
| | `value` | Number | `0` | false | The current progress value. | | ||
| | `max` | Number | `100` | false |The maximum progress value. | | ||
| | `position` | Number | `-1` | true | The current position of the progress bar. | | ||
|
|
||
| ### Attributes | ||
|
|
||
| | Property | Description | | ||
| |----------|------|---------|-------------| | ||
| | `value` | The current progress value. | | ||
| | `max` | The maximum progress value. | | ||
|
|
||
| ### Slots | ||
|
|
||
| | Slot | Description | | ||
| |------|-------------------------------------------------------------------| | ||
| | `default` | Fallback text to render if the component otherwise fails to load. | | ||
|
|
||
| ### Events | ||
|
|
||
| None | ||
|
|
||
| ## Accessibility | ||
|
|
||
| The `oui-progress` component will be exposed using the `progressbar` role. | ||
|
|
||
| The min (always 0) and max values will be exposed via `aria-valuemin` and `aria-valuemax` values (respectively). | ||
| The current value will be exposed via `aria-valuenow`. | ||
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.
Would it make sense to expose a slot for content in the filled in portion of the progress bar (e.g. a percentage number)?