Skip to content

Commit 8205df4

Browse files
committed
WIP
1 parent b29bb6d commit 8205df4

1 file changed

Lines changed: 26 additions & 16 deletions

File tree

  • packages/nimble-components/src/stepper/specs

packages/nimble-components/src/stepper/specs/README.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Nimble: Stepper is a generic component not designed for a specific application /
2626

2727
<!-- *A list of use cases, features, or functionality which are **not** goals for the component.* -->
2828

29-
- Handling long lists of steps (10s+)
29+
- Handling long lists of steps (10+)
3030
- Non-linear step progressions
3131

3232
### Features
@@ -103,28 +103,34 @@ The `step` elements will primarily render a provided nimble icon (and new nimble
103103
- severity: default / error / warning / success / information (aligned with icon)
104104
- severity-text: string (if provided, only renders during warning, error, and information severity)
105105
<!-- - Properties (not attribute reflected)
106-
- Methods
106+
- Methods -->
107107
- Events
108-
- CSS custom properties
109-
- CSS native properties
110-
-->
108+
- click (aligned to button, not emitted on disable)
109+
<!-- - CSS custom properties
110+
- CSS native properties -->
111111
- Slots
112-
- default: supports nimble icons, will render inside the circle and have color controlled via css
112+
- default: supports nimble icons, will render inside the circle and have color controlled via iconColor token
113113
- title: Title content (aligned with dialog)
114114
- subtitle: Subtitle content (aligned with dialog)
115115
<!-- - Parts
116116
- Localizable labels -->
117117

118118
- `nimble-anchor-step`
119119
- Attributes
120-
- Properties (not attribute reflected)
121-
- Methods
120+
- All `nimble-step` attributes
121+
- `<a>` attributes (href, target, etc)
122+
- Open question (for all anchors): Visual design of open in new window icon? Expected to slot in title?
123+
- href: null / undefined should behave like disabled (seems inconsistent across controls)
124+
<!-- - Properties (not attribute reflected)
125+
- Methods -->
122126
- Events
123-
- CSS custom properties
124-
- CSS native properties
127+
- click (aligned to anchor-button, not emitted on disable)
128+
<!-- - CSS custom properties
129+
- CSS native properties -->
125130
- Slots
126-
- Parts
127-
- Localizable labels
131+
- All `nimble-step` slots
132+
<!-- - Parts
133+
- Localizable labels -->
128134

129135
### Anatomy
130136
<!--
@@ -135,15 +141,15 @@ The `step` elements will primarily render a provided nimble icon (and new nimble
135141
- *Slotted Content/Slotted Classes*
136142
- *CSS Parts* -->
137143

138-
Merged above in API.
144+
Slots, parts, etc. merged above in API section.
139145

140146
### Native form integration
141147

142148
<!-- *Describe the plan for custom element form integration or why it's not necessary.*
143149
144150
*Components that are intended to replace a native form element (input, textarea, select) should generally behave like their native counterpart. See ["More capable form controls" on web.dev](https://web.dev/articles/more-capable-form-controls) for an overview of requirements. Leverage patterns from [FAST Form Associated Custom Elements](https://github.com/microsoft/fast/blob/master/packages/web-components/fast-foundation/src/form-associated/form-associated-custom-element.spec.md).* -->
145151

146-
N/A
152+
N/A, control has no intrinsic "value" state.
147153

148154
### Angular integration
149155

@@ -153,11 +159,15 @@ Angular `routerLink` integration for `nimble-anchor-step`
153159

154160
### Blazor integration
155161

156-
*Describe the plan for Blazor support, including form integration. See the [nimble-blazor CONTRIBUTING.md](/packages/blazor-workspace/NimbleBlazor/CONTRIBUTING.md) for details. Depending on the contributor's needs, implementing Blazor integration may be deferred but the initial spec should still document what work will be needed.*
162+
<!-- *Describe the plan for Blazor support, including form integration. See the [nimble-blazor CONTRIBUTING.md](/packages/blazor-workspace/NimbleBlazor/CONTRIBUTING.md) for details. Depending on the contributor's needs, implementing Blazor integration may be deferred but the initial spec should still document what work will be needed.* -->
163+
164+
Open Question: We have not historically taken Blazor Router support into account. To align with Blazor conventions we'd want to implement the same behavior as Blazor [`NavLink`](https://learn.microsoft.com/en-us/aspnet/core/blazor/fundamentals/navigation?view=aspnetcore-10.0#navlink-component) ([component src](https://github.com/dotnet/aspnetcore/blob/main/src/Components/Web/src/Routing/NavLink.cs)). Not sure how our current Blazor components behave with the router.
157165

158166
### Visual Appearance
159167

160-
*Work with Visual Design to create Figma files and other design assets. Be sure to account for the various component states, including hover, active, etc. as well as validity, and appearance variants.*
168+
<!-- *Work with Visual Design to create Figma files and other design assets. Be sure to account for the various component states, including hover, active, etc. as well as validity, and appearance variants.* -->
169+
170+
See figma linked in background.
161171

162172
---
163173

0 commit comments

Comments
 (0)