Skip to content

Commit e1c2eef

Browse files
committed
chore: first pass at overlay stories cleanup
1 parent fa6d08f commit e1c2eef

14 files changed

+4536
-31
lines changed

β€Ž1st-gen/packages/overlay/README.mdβ€Ž

Lines changed: 81 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,87 @@
1-
## Documentation index
1+
## πŸ“š Documentation
22

33
**New to overlays?** Start with the [Getting Started Guide](./GETTING-STARTED.md) to choose the right approach for your use case.
44

5-
### Core documentation
6-
7-
- [Getting Started Guide](./GETTING-STARTED.md) - Choose the right overlay entry point
8-
- [Architecture Documentation](./ARCHITECTURE.md) - Deep dive into how the overlay system works
9-
- [Troubleshooting Guide](./TROUBLESHOOTING.md) - Solutions to common problems
10-
11-
### Entry points
12-
13-
- **`<sp-overlay>`** - This document (below)
14-
- [`<overlay-trigger>`](./overlay-trigger.md) - Multiple interactions per trigger
15-
- [Imperative API](./imperative-api.md) - Programmatic overlay control
16-
- [Trigger directive](./trigger-directive.md) - Lit template integration
17-
- [Slottable request](./slottable-request.md) - Lazy content loading
18-
19-
### Integration guides
20-
21-
- [Forms Integration](./FORMS-INTEGRATION.md) - Validation popovers and field helpers
22-
- [Menus Integration](./MENUS-INTEGRATION.md) - Action menus and dropdown patterns
23-
- [Accessibility](./ACCESSIBILITY.md) - Focus management and ARIA patterns
24-
- [Performance](./PERFORMANCE.md) - Optimization strategies
5+
### πŸš€ Getting started
6+
7+
- **[Getting Started Guide](./GETTING-STARTED.md)** πŸ“˜ - Interactive decision tree to choose the right overlay approach
8+
- **[README](./README.md)** πŸ“„ - Component overview and basic usage (this document)
9+
10+
### πŸ“– Learn more
11+
12+
- **[Architecture](./ARCHITECTURE.md)** πŸ—οΈ - How the overlay system works internally
13+
- Overlay stack management
14+
- Interaction controllers (Click, Hover, Longpress)
15+
- Placement engine and collision detection
16+
- Event lifecycle
17+
- **[Accessibility](./ACCESSIBILITY.md)** β™Ώ - Focus management and ARIA patterns
18+
- Focus trapping and restoration
19+
- Keyboard navigation
20+
- Screen reader support
21+
- WCAG compliance
22+
- **[Performance](./PERFORMANCE.md)** ⚑ - Optimization strategies and benchmarks
23+
- Lazy loading with slottable-request
24+
- triggered-by optimization
25+
- Memory management
26+
- Performance metrics
27+
28+
### πŸ”§ Entry points
29+
30+
Choose the right API for your use case:
31+
32+
- **[`<sp-overlay>`](./README.md#usage)** 🎯 - Declarative overlay element (this document)
33+
- Single interaction per trigger
34+
- Fine-grained control
35+
- Virtual positioning support
36+
- **[`<overlay-trigger>`](./overlay-trigger.md)** 🎭 - Multiple interactions per trigger
37+
- Combined hover + click patterns
38+
- Slot-based API
39+
- Automatic lifecycle management
40+
- **[Imperative API](./imperative-api.md)** βš™οΈ - Programmatic overlay control
41+
- Dynamic overlay creation
42+
- VirtualTrigger for cursor positioning
43+
- Full lifecycle control
44+
- **[Trigger Directive](./trigger-directive.md)** πŸ”— - Lit template integration
45+
- Lit framework specific
46+
- Reactive content updates
47+
- TypeScript integration
48+
- **[Slottable Request](./slottable-request.md)** πŸš€ - Lazy content loading
49+
- Performance optimization
50+
- Reduce initial DOM size
51+
- On-demand content creation
52+
53+
### 🎯 Integration guides
54+
55+
Real-world patterns and best practices:
56+
57+
- **[Forms Integration](./FORMS-INTEGRATION.md)** πŸ“ - Validation and field helpers
58+
- Validation popovers
59+
- Field error display
60+
- Picker integration
61+
- Form field helpers
62+
- **[Menus Integration](./MENUS-INTEGRATION.md)** πŸ“‹ - Action menus and dropdowns
63+
- Context menus
64+
- Action menus
65+
- Dropdown patterns
66+
- Menu positioning
67+
68+
### πŸ” Troubleshooting
69+
70+
- **[Troubleshooting Guide](./TROUBLESHOOTING.md)** πŸ”§ - Symptom-based problem diagnosis
71+
- Overlay won't open
72+
- Overlay won't close
73+
- Positioning issues
74+
- Focus management problems
75+
- Performance issues
76+
- Accessibility issues
77+
78+
### πŸ“Š Additional resources
79+
80+
- **[Storybook Examples](https://opensource.adobe.com/spectrum-web-components/storybook)** - Interactive examples and demos
81+
- **[GitHub Discussions](https://github.com/adobe/spectrum-web-components/discussions)** - Ask questions and share feedback
82+
- **[GitHub Issues](https://github.com/adobe/spectrum-web-components/issues)** - Report bugs and request features
83+
84+
---
2585

2686
## Overview
2787

0 commit comments

Comments
Β (0)