|
1 | | -## Documentation index |
| 1 | +## π Documentation |
2 | 2 |
|
3 | 3 | **New to overlays?** Start with the [Getting Started Guide](./GETTING-STARTED.md) to choose the right approach for your use case. |
4 | 4 |
|
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 | +--- |
25 | 85 |
|
26 | 86 | ## Overview |
27 | 87 |
|
|
0 commit comments