You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/website/docs/components/containers/flyout/_flyout_menu.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,5 +47,5 @@ export default () => {
47
47
};
48
48
```
49
49
50
-
In [managed session flyouts](./session-management.mdx), the Flyout Manager automatically adds a back button and a history popover control to the flyout menu for navigating to different flyout sessions within the managed context.
50
+
In [managed session flyouts](#flyout-session-management), the Flyout Manager automatically adds a back button and a history popover control to the flyout menu for navigating to different flyout sessions within the managed context.
EuiFlyout comes with opt-in flyout session management built in that lets you
12
8
effortlessly create complex flyout compositions and journeys.
@@ -113,7 +109,7 @@ export default () => {
113
109
};
114
110
```
115
111
116
-
## Sessions
112
+
####Sessions
117
113
118
114
The `session` prop is the key ingredient needed to create managed flyouts.
119
115
When set to `start`, it activates the underlying flyout session management logic
@@ -136,7 +132,7 @@ When a flyout is nested inside a parent flyout and doesn't have an explicit
136
132
`session` prop, it will automatically inherit the session. All bindings and
137
133
configuration will be handled automatically.
138
134
139
-
### Session title
135
+
#####Session title
140
136
141
137
Managed flyout sessions require a title that can be referenced in the history
142
138
navigation features. Use the `title` field of the `flyoutMenuProps` to set the
@@ -211,13 +207,13 @@ explicitly set `session="never"`. This will render it as a regular unmanaged fly
211
207
</>
212
208
```
213
209
214
-
## Types of managed flyouts
210
+
####Types of managed flyouts
215
211
216
212
While users of managed flyouts don't need to think about the types
217
213
of managed flyouts or the internals behind them, it's beneficial to understand
218
214
what differentiates the two types - _main_ and _child_.
219
215
220
-
### Main flyouts
216
+
#####Main flyouts
221
217
222
218
Main flyouts are the backbone of EuiFlyout's session management. Each flyout
223
219
with `session="start"` prop creates a new session and becomes the main flyout
@@ -227,7 +223,7 @@ using the history popover.
227
223
Main flyouts are meant to display primary level information like the overview
228
224
of an alert.
229
225
230
-
### Child flyouts
226
+
#####Child flyouts
231
227
232
228
Child flyouts are directly related to a main flyout in their session. They're
233
229
created by rendering an `EuiFlyout` inside a main flyout's children (nested in
@@ -242,7 +238,7 @@ the style of the flyout background to shaded ([`colors.backgroundBaseSubdued`](.
242
238
243
239
On smaller screens, child flyouts stack above the parent.
244
240
245
-
## Accessibility
241
+
####Accessibility
246
242
247
243
Both parent and child flyouts use `role="dialog"` and `aria-modal="true"` for accessibility. Focus is managed automatically between them, with the child flyout taking focus when open and returning focus to the parent when closed.
0 commit comments