-
Notifications
You must be signed in to change notification settings - Fork 106
feat: pfe-progress-steps [new component] (#1436) #1613
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
Merged
castastrophe
merged 79 commits into
master
from
issue-1405-product-trials-epic--progress-steps
May 21, 2021
Merged
Changes from all commits
Commits
Show all changes
79 commits
Select commit
Hold shift + click to select a range
3053f41
fix: merged master fix and issue-1405-product-trials-epic--broken-master
heyMP 6268c10
feat: added better logic for switching grid gaps for button-group
heyMP 326bf7f
feat: updated demo
heyMP 6a8e605
Branch was auto-updated with the latest.
github-actions[bot] a2d154d
Branch was auto-updated with the latest.
github-actions[bot] a1e2d41
Branch was auto-updated with the latest.
github-actions[bot] 9bc0e12
feat: pfe-progress-steps disable link on current and error state.
heyMP 45a052b
feat: pfe-progress-steps fixed thin white line around svgs
heyMP f979a99
chore: pfe-progress-steps cleanup
heyMP d7c179f
feat: updated demo to use remote libs
heyMP 2c16e15
fix: pfe-popover fixed darkmode button color
heyMP 402a089
feat: pfe-absolute-position switch from attr change callback to prop …
heyMP 8dcc1c4
Branch was auto-updated with the latest.
github-actions[bot] ece1f66
Branch was auto-updated with the latest.
github-actions[bot] 53329ed
Branch was auto-updated with the latest.
github-actions[bot] 6bf829a
Branch was auto-updated with the latest.
github-actions[bot] c0a56e0
Branch was auto-updated with the latest.
github-actions[bot] ffb9734
Branch was auto-updated with the latest.
github-actions[bot] a2b4b35
fix: pfe-alert added correct icon gap, moved to css grid
heyMP ab24554
chore: update to 1.6.0
heyMP 737b56c
chore: commit dist files for short term
heyMP 5195dc1
Branch was auto-updated with the latest.
github-actions[bot] 40f85d1
Branch was auto-updated with the latest.
github-actions[bot] ecc9fc6
Branch was auto-updated with the latest.
github-actions[bot] bedf0f7
Branch was auto-updated with the latest.
github-actions[bot] 59bc5fc
Branch was auto-updated with the latest.
github-actions[bot] ae4d1f1
Branch was auto-updated with the latest.
github-actions[bot] f67b227
Branch was auto-updated with the latest.
github-actions[bot] 488a9d6
Branch was auto-updated with the latest.
github-actions[bot] 2702beb
Branch was auto-updated with the latest.
github-actions[bot] 7a0269d
Branch was auto-updated with the latest.
github-actions[bot] fe48eac
Branch was auto-updated with the latest.
github-actions[bot] 51d7a09
Branch was auto-updated with the latest.
github-actions[bot] e5edb24
Branch was auto-updated with the latest.
github-actions[bot] e92f2b0
chore: remove dist files
heyMP e6423aa
chore: removing unrelated components
heyMP 8627b00
chore: removing dist directories
heyMP 6602dbd
chore: remove console.log
heyMP 30d25cb
feat: made vertical min-height dynamic
heyMP 6f9324e
chore: version bump
heyMP 521834c
Merge branch 'master' of github.com:patternfly/patternfly-elements in…
castastrophe 9a7b14a
First pass at updating styles to use pfe functions
castastrophe 2e80f5c
Remove debugging
castastrophe 1cf8b7f
Update polyfills
castastrophe 17782cc
Add documentation folder
castastrophe 89270f3
Remove jump links content from progress stepper docs
castastrophe 4f92440
Add documentation for the variable hooks
castastrophe 0ebee00
Merge branch 'master' into issue-1405-product-trials-epic--progress-s…
castastrophe f314f6d
Update documentation; add values array
castastrophe 4de6168
First pass at storybook view
castastrophe e0a0729
Abstract item template
castastrophe 3108731
Update story
castastrophe 3e95a75
Merge branch 'master' of github.com:patternfly/patternfly-elements in…
castastrophe d2fcc5b
Update tests for progress steps
castastrophe 94bf237
Update progress steps
castastrophe 8d8c704
Add todo notes
castastrophe 70707d9
Remove progress steps html now that it's using the new testing framework
castastrophe 90da8ca
Merge branch 'issue-1405-product-trials-epic--progress-steps' of gith…
castastrophe 3ee2aa8
[pfe-progress-steps] CSS Variable Notes NO MERGE (#1623)
heyMP 46bd609
Reworking the styles to simplify the markup
castastrophe d280a56
Merge branch 'issue-1405-product-trials-epic--progress-steps' of gith…
castastrophe 9900d7d
Fixing a few hangnails
castastrophe 4f0b158
Update links to use inherit
castastrophe 82cda54
Update logic to use more precise math for determining alignment
castastrophe a884e59
Revert storybook update
castastrophe 8dea590
Merge branch 'master' into issue-1405-product-trials-epic--progress-s…
castastrophe 9eff2ff
Minor updates
castastrophe a259d58
Merge branch 'master' into issue-1405-product-trials-epic--progress-s…
castastrophe 958f8c2
Merge branch 'master' of github.com:patternfly/patternfly-elements in…
castastrophe 938b8a2
update changelog
castastrophe 0601928
Updating typo
castastrophe 6a91143
Merge branch 'master' into issue-1405-product-trials-epic--progress-s…
heyMP 12fd577
Remove html test from old testing suite
castastrophe 0d9ef93
Update styles on demo page
castastrophe 0182c2b
feat: updated css vars for RH theme in demo
heyMP 9337333
feat: updated preview image for docs
heyMP 7a59dbc
fix: fixed the description of the progress steps
heyMP 1d51ba0
Update feedback--info colors to ui-accent
castastrophe 78d8ec0
Merge branch 'master' into issue-1405-product-trials-epic--progress-s…
castastrophe 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,19 @@ | ||
| Copyright 2021 Red Hat, Inc. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in | ||
| all copies or substantial portions of the Software. | ||
|
|
||
| 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. |
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,101 @@ | ||
| # PatternFly Element | Progress stepper element | ||
| A component that gives the user a visual representation of the current state of their progress through an application (typically a multistep form). | ||
|
|
||
| ## Usage | ||
| Describe how best to use this web component along with best practices. | ||
|
|
||
| ```html | ||
| <pfe-progress-steps> | ||
| <pfe-progress-steps-item state="active" current> | ||
| <div slot="title">Current</div> | ||
| <a slot="link" href="#">View current step</a> | ||
| </pfe-progress-steps-item> | ||
| <pfe-progress-steps-item> | ||
| <div slot="title">Next</div> | ||
| <a slot="link" href="#">View next step</a> | ||
| </pfe-progress-steps-item> | ||
| <pfe-progress-steps-item> | ||
| <div slot="title">Last</div> | ||
| <a slot="link" href="#">View last step</a> | ||
| </pfe-progress-steps-item> | ||
| </pfe-progress-steps> | ||
| ``` | ||
|
|
||
| ## Slots | ||
|
|
||
| ### pfe-progress-steps-item | ||
|
|
||
| - `title`: The item's short descriptive title. | ||
castastrophe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - `description`: A short description of what the item represents. | ||
|
|
||
| ## Attributes | ||
|
|
||
| ### pfe-progress-steps | ||
|
|
||
| - `vertical`: Describe each available attribute and what function is serves. | ||
castastrophe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### pfe-progress-steps-item | ||
|
|
||
| - `current`: Indicates if this item is the current active item. | ||
| - `state`: Describes the state of the current item; allows "inactive", "done", or "error". | ||
|
|
||
| ## Variable hooks | ||
|
|
||
| Available hooks for styling: | ||
|
|
||
| | Variable name | Default value | Region | | ||
| | --- | --- | --- | | ||
| | `--pfe-progress-steps__item--Width` | var(--pfe-theme--ui--element--size--lg, 75px) | item | | ||
| | `--pfe-progress-steps__circle--Size` | var(--pfe-theme--ui--element--size--md, 32px) | circle | | ||
| | `--pfe-progress-steps__progress-bar--Color` | var(--pfe-theme--color--ui--border--lighter, #d2d2d2) | progress | | ||
| | `--pfe-progress-steps__progress-bar--Fill` | var(--pfe-theme--color--ui-accent, #06c) | progress | | ||
| | `--pfe-progress-steps__progress-bar--Width` | var(--pfe-theme--ui--border-width--md, 2px) | progress | | ||
| | --- | --- | --- | | ||
| | `--pfe-progress-steps-item--Width` | auto | | | ||
| | `--pfe-progress-steps-item--MinHeight--vertical` | var(--pfe-progress-steps__item--Width, var(--pfe-theme--ui--element--size--lg, 75px)) | | | ||
| | `--pfe-progress-steps-item__circle--Size` | var(--pfe-theme--ui--element--size--md, 32px) | circle | | ||
| | `--pfe-progress-steps-item__circle--Color` | var(--pfe-theme--color--feedback--info, #06c) | circle | | ||
| | `--pfe-progress-steps-item__circle--Color--hover` | var(--pfe-theme--color--feedback--info, #06c) | circle | | ||
| | `--pfe-progress-steps-item__circle--Color--focus` | var(--pfe-theme--color--feedback--info, #06c) | circle | | ||
| | `--pfe-progress-steps-item__circle--Background` | radial-gradient(circle, white 60%, rgba(255, 255, 255, 0) 61%) | circle | | ||
| | `--pfe-progress-steps-item__circle--Width` | var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px)) | circle | | ||
| | `--pfe-progress-steps-item__circle--Height` | var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px)) | circle | | ||
| | `--pfe-progress-steps-item__circle-wrapper--Width` | var(--pfe-progress-steps-item__circle--Width, var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px))) | circle | | ||
| | `--pfe-progress-steps-item__circle-wrapper--Height` | var(--pfe-progress-steps-item__circle--Height, var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px))) | circle | | ||
| | `--pfe-progress-steps-item__title--Color` | var(--pfe-theme--color--text, #151515) | title | | ||
| | `--pfe-progress-steps-item__title--Color--active` | var(--pfe-theme--color--feedback--info, #06c) | title | | ||
| | `--pfe-progress-steps-item__title--Color--error` | var(--pfe-theme--color--feedback--critical--lighter, #c9190b) | title | | ||
| | `--pfe-progress-steps-item__title--MarginTop--vertical` | calc( var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px)) / 6) | title | | ||
| | `--pfe-progress-steps-item__description--Color` | var(--pfe-theme--color--text--muted, #6a6e73) | description | | ||
| | `--pfe-progress-steps-item__description--Color--error` | var(--pfe-theme--color--feedback--critical--lighter, #c9190b) | description | | ||
| | `--pfe-progress-steps-item--spacer` | var(--pfe-theme--content-spacer--body--sm, 0.5rem) | | | ||
| | `--pfe-progress-steps-item__circle-inner--Width` | calc( var(--pfe-progress-steps-item__circle--Width, var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px))) / 2.2) | circle | | ||
| | `--pfe-progress-steps-item__circle-inner--Height` | calc( var(--pfe-progress-steps-item__circle--Height, var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px))) / 2.2) | circle | | ||
| | `--pfe-progress-steps-item__circle-outer--Width` | var(--pfe-progress-steps-item__circle--Width, var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px))) | circle | | ||
| | `--pfe-progress-steps-item__circle-outer--Height` | var(--pfe-progress-steps-item__circle--Height, var(--pfe-progress-steps-item__circle--Size, var(--pfe-theme--ui--element--size--md, 32px))) | circle | | ||
|
|
||
| ## Dev | ||
|
|
||
| `npm start` | ||
|
|
||
| ## Test | ||
|
|
||
| `npm run test` | ||
|
|
||
| ## Build | ||
|
|
||
| `npm run build` | ||
|
|
||
| ## Demo | ||
|
|
||
| From the PFElements root directory, run: | ||
|
|
||
| `npm run demo` | ||
|
|
||
| ## Code style | ||
|
|
||
| Progress stepper (and all PFElements) use [Prettier][prettier] to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can [integrate your editor][prettier-ed] with Prettier to have the style rules applied on every save. | ||
|
|
||
| [prettier]: https://github.com/prettier/prettier/ | ||
| [prettier-ed]: https://prettier.io/docs/en/editors.html | ||
| [web-component-tester]: https://github.com/Polymer/web-component-tester | ||
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.
Uh oh!
There was an error while loading. Please reload this page.