Skip to content

Commit eb732db

Browse files
committed
feedback
1 parent f073401 commit eb732db

5 files changed

Lines changed: 21 additions & 16 deletions

File tree

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

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The `nimble-stepper`, `nimble-step`, and `nimble-anchor-step` elements.
1111
- *Link to relevant work items, related existing issues, etc.*
1212
-->
1313

14+
- Nimble issue: [#624](https://github.com/ni/nimble/issues/624)
1415
- Interaction Design: None
1516
- Visual Design:
1617
- [Nimble Components Stepper Figma](https://www.figma.com/design/PO9mFOu5BCl8aJvFchEeuN/Nimble_Components?node-id=11742-71097&p=f&t=U3UnPlU4awyN4ybh-0)
@@ -27,7 +28,7 @@ Nimble: Stepper is a generic component not designed for a specific application /
2728
<!-- *A list of use cases, features, or functionality which are **not** goals for the component.* -->
2829

2930
- Handling long lists of steps (10+)
30-
- Non-linear step progressions
31+
- Non-linear step progressions such as following steps in a branching flow chart or graph are not in the scope of the current HLD / designs.
3132

3233
### Features
3334

@@ -97,7 +98,6 @@ The `step` elements will primarily render a provided nimble icon (and new nimble
9798
- `nimble-step`
9899
- Attributes
99100
- disabled: boolean (standard, i.e. visually disabled and interactions prevented)
100-
- `disabled[appearance-readonly]`: (standard, i.e. visually not disabled, interactions prevented)
101101
- readonly: boolean (standard, i.e. visually not disabled, interactions other than tab focus prevented)
102102
- selected: boolean (visual change only, no behavior) (aligned with card button)
103103
- severity: default / error / warning / success / information (aligned with icon)
@@ -173,7 +173,15 @@ Slots, parts, etc. merged above in API section.
173173

174174
See figma linked in background section.
175175

176-
---
176+
### Interactions
177+
178+
<!-- *Work with Interaction Design to create Figma files and other design assets. Be sure to account for the various interactions from mouse, keyboard, and touch * -->
179+
180+
Step button / link interaction area is the step control size boundaries which includes the icon, title, subtitle, and the line visual. The control size / interaction area does not include the severity text (similar to error text in other controls).
181+
182+
See the blue areas in the following image as an example:
183+
184+
![step interaction bounds](./stepper-interaction-bounds.png)
177185

178186
## Implementation
179187

@@ -189,7 +197,10 @@ No particularly interesting implementation concerns. Follows existing patterns a
189197

190198
<!-- *Key component states, valid state transitions, and how interactions trigger a state transition.* -->
191199

192-
Nothing unique beyond what's captured in the API section.
200+
Some specific usage notes:
201+
- Only one step should be marked selected at a time
202+
- Disabled steps represent a step that doesn't apply for the current workflow (previous step configuration disabled a future step which is now skipped)
203+
- Readonly steps are steps that don't have associated views for them (it's a step that just indicates something like disk formatted or software installed)
193204

194205
### Accessibility
195206

37.4 KB
Loading

specs/templates/component-interaction-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@
4141
*Highlight any open questions for discussion during the spec PR. Before the spec is approved these should typically be resolved with the answers incorporated in this document.*
4242

4343
## Future Considerations
44-
*List any open questions or future work for discussion not currently scoped to this document.*
44+
*List any open questions or future work for discussion not currently scoped to this document.*

specs/templates/custom-component.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@
3131

3232
*Screenshots and/or links to existing, canonical, or exemplary implementations of the component.*
3333

34-
---
35-
3634
## Design
3735

3836
*Describe the design of the component, thinking through several perspectives:*
@@ -85,7 +83,9 @@
8583

8684
*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.*
8785

88-
---
86+
### Interactions
87+
88+
*Work with Interaction Design to create Figma files and other design assets. Be sure to account for the various interactions from mouse, keyboard, and touch.*
8989

9090
## Implementation
9191

@@ -159,7 +159,6 @@
159159

160160
*What additions or changes are needed for user documentation and demos? Are there any architectural/engineering docs we should create as well, perhaps due to some interesting technical challenge or design decisions related to this component?*
161161

162-
---
163162
## Open Issues
164163

165-
*Highlight any open questions for discussion during the spec PR. Before the spec is approved these should typically be resolved with the answers being incorporated in the spec document.*
164+
*Highlight any open questions for discussion during the spec PR. Before the spec is approved these should typically be resolved with the answers being incorporated in the spec document.*

specs/templates/fast-based-component.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414

1515
*State whether this component be part of Nimble or Spright and provide justification or considerations leading to that decision.*
1616

17-
---
18-
1917
## Design
2018

2119
*Include code snippets showing basic component use and any interesting configurations.*
@@ -42,7 +40,6 @@
4240

4341
*Summarize the component's form integration. Is it built in to FAST, requiring custom development, or not necessary?*
4442

45-
4643
### Angular integration
4744

4845
*Describe the plan for Angular support, including directives for attribute binding and ControlValueAccessor for form integration. Depending on the contributor's needs, implementing Angular integration may be deferred but the initial spec should still document what work will be needed.*
@@ -67,8 +64,6 @@
6764
- *Performance: does the FAST component meet Nimble's performance requirements?*
6865
- *Security: Any requirements for security?*
6966

70-
---
71-
7267
## Open Issues
7368

74-
*Highlight any open questions for discussion during the spec PR. Before the spec is approved these should typically be resolved with the answers being incorporated in the spec document.*
69+
*Highlight any open questions for discussion during the spec PR. Before the spec is approved these should typically be resolved with the answers being incorporated in the spec document.*

0 commit comments

Comments
 (0)