@fundamental-styles/mcp 0.41.7-rc.8 → 0.41.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/AI_USAGE.md +425 -0
- package/data/CHANGELOG.md +53 -3
- package/data/component-catalog.json +62 -209
- package/data/components/README.md +281 -0
- package/data/components/action-bar.md +443 -0
- package/data/components/ai-busy-indicator.md +79 -0
- package/data/components/ai-loading-bar.md +66 -0
- package/data/components/avatar-btp.md +198 -0
- package/data/components/avatar-group.md +2660 -0
- package/data/components/avatar-product-switch.md +476 -0
- package/data/components/avatar.md +993 -0
- package/data/components/bar.md +574 -0
- package/data/components/border-radius.md +148 -0
- package/data/components/border.md +412 -0
- package/data/components/breadcrumb.md +546 -0
- package/data/components/button-2.md +440 -0
- package/data/components/button-action-sheet.md +292 -0
- package/data/components/button-ai.md +730 -0
- package/data/components/button-btp.md +223 -0
- package/data/components/button-button.md +233 -0
- package/data/components/button-counter.md +176 -0
- package/data/components/button-patterns.md +731 -0
- package/data/components/button-split.md +459 -0
- package/data/components/button.md +469 -0
- package/data/components/calendar.md +5784 -0
- package/data/components/card-card-media.md +707 -0
- package/data/components/card-card.md +2426 -0
- package/data/components/card-layouts.md +1201 -0
- package/data/components/card.md +2404 -0
- package/data/components/carousel.md +1506 -0
- package/data/components/code.md +139 -0
- package/data/components/component-reset.md +272 -0
- package/data/components/components-icons-businesssuiteinappsymbol-icons.md +85 -0
- package/data/components/components-icons-sap-icons.md +147 -0
- package/data/components/components-icons-tnt-icons.md +85 -0
- package/data/components/container-queries.md +221 -0
- package/data/components/container.md +227 -0
- package/data/components/dialog-docs-static-busy-indicator.md +165 -0
- package/data/components/dialog-docs-static-dialog.md +949 -0
- package/data/components/dialog-docs-static-patterns.md +147 -0
- package/data/components/dialog-docs-static-settings.md +528 -0
- package/data/components/dialog-docs-static.md +982 -0
- package/data/components/dialog.md +606 -0
- package/data/components/dynamic-page-dynamic-page.md +1914 -0
- package/data/components/dynamic-page.md +973 -0
- package/data/components/dynamic-side.md +197 -0
- package/data/components/elevation.md +110 -0
- package/data/components/feed-input.md +346 -0
- package/data/components/feed-list.md +580 -0
- package/data/components/fieldset-2.md +292 -0
- package/data/components/fieldset-forms.md +169 -0
- package/data/components/fieldset.md +381 -0
- package/data/components/flexible-column-layout.md +205 -0
- package/data/components/form-group.md +287 -0
- package/data/components/form-header.md +71 -0
- package/data/components/form-item-2.md +98 -0
- package/data/components/form-item-3.md +134 -0
- package/data/components/form-item-4.md +556 -0
- package/data/components/form-item-5.md +182 -0
- package/data/components/form-item-6.md +539 -0
- package/data/components/form-item-7.md +239 -0
- package/data/components/form-item-ai.md +158 -0
- package/data/components/form-item-file-uploader.md +445 -0
- package/data/components/form-item-forms.md +234 -0
- package/data/components/form-item-patterns.md +426 -0
- package/data/components/form-item.md +464 -0
- package/data/components/form-label-ai.md +126 -0
- package/data/components/form-label-layouts.md +306 -0
- package/data/components/form-label-patterns.md +1175 -0
- package/data/components/form-label-status-indicator.md +1083 -0
- package/data/components/form-label-step-input.md +620 -0
- package/data/components/form-label.md +2876 -0
- package/data/components/generic-tag.md +747 -0
- package/data/components/grid-list-grid-list.md +1185 -0
- package/data/components/grid-list.md +1449 -0
- package/data/components/heading.md +66 -0
- package/data/components/horizontal-navigation.md +568 -0
- package/data/components/icon-tab-bar-dev.md +190 -0
- package/data/components/icon-tab-bar.md +2620 -0
- package/data/components/icon.md +171 -0
- package/data/components/iconBusinessSuite.md +92 -0
- package/data/components/iconTnt.md +92 -0
- package/data/components/illustrated-message.md +439 -0
- package/data/components/info-label.md +348 -0
- package/data/components/input-group.md +2068 -0
- package/data/components/label.md +66 -0
- package/data/components/layout-grid.md +447 -0
- package/data/components/layout-panel.md +261 -0
- package/data/components/layouts-layout-grid.md +608 -0
- package/data/components/layouts-paddings.md +133 -0
- package/data/components/layouts-section.md +287 -0
- package/data/components/list-2.md +148 -0
- package/data/components/list-3.md +735 -0
- package/data/components/list-list.md +790 -0
- package/data/components/list-object-list.md +1225 -0
- package/data/components/list.md +1286 -0
- package/data/components/media-queries.md +168 -0
- package/data/components/menu.md +946 -0
- package/data/components/message-box-docs-static-ai.md +149 -0
- package/data/components/message-box-docs-static.md +527 -0
- package/data/components/message-page-upload-collection.md +678 -0
- package/data/components/message-page.md +256 -0
- package/data/components/message-strip.md +977 -0
- package/data/components/message-toast.md +119 -0
- package/data/components/micro-process-flow.md +991 -0
- package/data/components/navigation-menu.md +366 -0
- package/data/components/navigation-navigation.md +1245 -0
- package/data/components/navigation.md +2604 -0
- package/data/components/numeric-content.md +317 -0
- package/data/components/object-attribute.md +96 -0
- package/data/components/object-identifier.md +227 -0
- package/data/components/object-marker.md +202 -0
- package/data/components/object-number.md +327 -0
- package/data/components/object-status.md +1538 -0
- package/data/components/off-screen.md +87 -0
- package/data/components/overflow.md +97 -0
- package/data/components/padding.md +122 -0
- package/data/components/paddings.md +130 -0
- package/data/components/page.md +300 -0
- package/data/components/pagination.md +672 -0
- package/data/components/panel-layouts.md +345 -0
- package/data/components/panel.md +514 -0
- package/data/components/patterns-label.md +74 -0
- package/data/components/popover-2.md +906 -0
- package/data/components/popover-ai.md +466 -0
- package/data/components/popover-btp.md +886 -0
- package/data/components/popover-deprecated.md +308 -0
- package/data/components/popover-message-popover.md +683 -0
- package/data/components/popover-notification.md +1511 -0
- package/data/components/popover-patterns.md +1100 -0
- package/data/components/popover-popover.md +1862 -0
- package/data/components/popover-quick-view.md +385 -0
- package/data/components/popover-timepicker.md +1836 -0
- package/data/components/popover-user-menu.md +1303 -0
- package/data/components/popover.md +1938 -0
- package/data/components/progress-indicator.md +351 -0
- package/data/components/prompt-input-ai.md +226 -0
- package/data/components/prompt-input.md +226 -0
- package/data/components/rating-indicator.md +1469 -0
- package/data/components/resizable-card-layout.md +951 -0
- package/data/components/scrollbar.md +86 -0
- package/data/components/search-field.md +287 -0
- package/data/components/section.md +250 -0
- package/data/components/segmented-button.md +324 -0
- package/data/components/shellbar.md +2183 -0
- package/data/components/side-nav.md +1562 -0
- package/data/components/skeleton.md +243 -0
- package/data/components/slider.md +395 -0
- package/data/components/splitter.md +353 -0
- package/data/components/table.md +2749 -0
- package/data/components/tabs.md +658 -0
- package/data/components/text-text.md +380 -0
- package/data/components/text.md +253 -0
- package/data/components/tile.md +1132 -0
- package/data/components/time.md +818 -0
- package/data/components/title.md +153 -0
- package/data/components/titles.md +83 -0
- package/data/components/token.md +311 -0
- package/data/components/tokenizer.md +398 -0
- package/data/components/tool-header.md +1352 -0
- package/data/components/tool-layout.md +199 -0
- package/data/components/toolbar-ai.md +174 -0
- package/data/components/toolbar-btp.md +526 -0
- package/data/components/toolbar-title-bar.md +473 -0
- package/data/components/toolbar.md +432 -0
- package/data/components/tree.md +1031 -0
- package/data/components/typography.md +435 -0
- package/data/components/variant-management.md +360 -0
- package/data/components/vertical-nav.md +589 -0
- package/data/components/wizard.md +1429 -0
- package/data/examples/Components/dialog/device-specifications.example.html +39 -30
- package/data/examples/Components/shellbar/optional-items.example.html +210 -157
- package/data/examples/Components/shellbar/overflow-toolbar.example.html +202 -177
- package/data/examples/Components/shellbar/responsive-paddings.example.html +217 -146
- package/data/examples/Components/shellbar/responsiveness.example.html +825 -613
- package/data/examples/Components/user-menu/default.example.html +241 -83
- package/data/schemas/badge.schema.json +1 -1
- package/data/schemas/button-split.schema.json +1 -1
- package/data/schemas/component-frontmatter.schema.json +123 -0
- package/data/schemas/component-markdown.schema.json +81 -0
- package/data/schemas/counter.schema.json +1 -1
- package/data/schemas/dynamic-page.schema.json +1 -1
- package/data/schemas/dynamic-side-content.schema.json +1 -1
- package/data/schemas/facet.schema.json +1 -1
- package/data/schemas/fieldset.schema.json +1 -1
- package/data/schemas/flexible-column-layout.schema.json +1 -1
- package/data/schemas/form-group.schema.json +3 -2
- package/data/schemas/form-header.schema.json +1 -1
- package/data/schemas/form-label.schema.json +1 -0
- package/data/schemas/form-message.schema.json +1 -1
- package/data/schemas/grid-list.schema.json +1 -1
- package/data/schemas/input-group.schema.json +1 -1
- package/data/schemas/layout-panel.schema.json +1 -1
- package/data/schemas/page.schema.json +1 -1
- package/data/schemas/quick-view.schema.json +2 -1
- package/data/schemas/section.schema.json +1 -1
- package/data/schemas/side-nav.schema.json +1 -1
- package/data/schemas/splitter.schema.json +1 -1
- package/data/schemas/tabs.schema.json +1 -1
- package/data/schemas/tile.schema.json +1 -1
- package/data/schemas/tool-layout.schema.json +1 -1
- package/data/schemas/user-menu.schema.json +10 -0
- package/data/schemas/wizard.schema.json +1 -1
- package/package.json +1 -1
- package/src/data/load-catalog.d.ts +2 -0
- package/src/data/load-catalog.js +5 -1
- package/src/data/load-catalog.js.map +1 -1
- package/src/data/load-markdown-docs.d.ts +44 -0
- package/src/data/load-markdown-docs.js +179 -0
- package/src/data/load-markdown-docs.js.map +1 -0
- package/src/data/markdown-cache.d.ts +60 -0
- package/src/data/markdown-cache.js +218 -0
- package/src/data/markdown-cache.js.map +1 -0
- package/src/server.js +72 -1
- package/src/server.js.map +1 -1
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: fd-tool-layout
|
|
3
|
+
title: Layouts/Tool Layout
|
|
4
|
+
category: Layouts
|
|
5
|
+
selector: fd-tool-layout
|
|
6
|
+
cssFile: tool-layout.css
|
|
7
|
+
sourcePath: packages/styles/stories/Layouts/tool-layout/tool-layout.stories.js
|
|
8
|
+
tags: []
|
|
9
|
+
dependencies: ["tool-layout"]
|
|
10
|
+
relatedComponents: ["tool-layout"]
|
|
11
|
+
stability: stable
|
|
12
|
+
generatedAt: 2026-06-09T18:29:01.704Z
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Layouts/Tool Layout
|
|
16
|
+
|
|
17
|
+
## Anatomy
|
|
18
|
+
- <b>Tool Header </b>- always present and is a top-aligned UI element that contains global actions and controls navigation
|
|
19
|
+
- <b>Navigation </b>- side navigation in all of its variants (expanded, snapped)
|
|
20
|
+
- <b>Content </b>- an empty container area that can hold any content.
|
|
21
|
+
|
|
22
|
+
## Structure
|
|
23
|
+
- <code>.fd-tool-layout</code>
|
|
24
|
+
- <code>.fd-tool-layout--tablet</code> - modifier class for tablets
|
|
25
|
+
- <code>.fd-tool-layout--phone</code> - modifier class for phones
|
|
26
|
+
- <code>.fd-tool-layout--sticky</code> - modifier class for positioning the header on the top
|
|
27
|
+
- <code>.fd-tool-layout--horizontal-navigation</code> - modifier class for layout with Horizontal Navigation
|
|
28
|
+
- <code>.fd-tool-layout\\_\\_container</code>
|
|
29
|
+
- <code>.fd-tool-layout\\_\\_header-container</code> - wraping element around the Tool Header
|
|
30
|
+
- <code>.fd-tool-layout\\_\\_navigation-container</code> - wraping element around the Navigation (all its variants)
|
|
31
|
+
- <code>.fd-tool-layout\\_\\_navigation-container--horizontal</code> - modifier class for when the navigation is horizontal
|
|
32
|
+
- <code>.fd-tool-layout\\_\\_content-container</code> - wraping element around the page content. By default, the background of the content area is <code>var(--sapBackgroundColor)</code>
|
|
33
|
+
- <code>.fd-tool-layout\\_\\_content-container--transparent</code> - modifier class to apply transparent background to the content area.
|
|
34
|
+
- <code>.fd-tool-layout\\_\\_content-container--list</code> - modifier class to apply list <code>var(--sapGroup_ContentBackground)</code> background to the content area.
|
|
35
|
+
|
|
36
|
+
## Dependencies
|
|
37
|
+
|
|
38
|
+
This component depends on the following CSS files:
|
|
39
|
+
|
|
40
|
+
- `tool-layout.css`
|
|
41
|
+
|
|
42
|
+
## Installation
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm install fundamental-styles
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
```html
|
|
49
|
+
<!-- Include theme -->
|
|
50
|
+
<link href="node_modules/fundamental-styles/dist/theming/sap_horizon.css" rel="stylesheet">
|
|
51
|
+
|
|
52
|
+
<!-- Include component CSS -->
|
|
53
|
+
<link href="node_modules/fundamental-styles/dist/tool-layout.css" rel="stylesheet">
|
|
54
|
+
|
|
55
|
+
<!-- Include dependencies -->
|
|
56
|
+
<link href="node_modules/fundamental-styles/dist/tool-layout.css" rel="stylesheet">
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Basic Usage
|
|
60
|
+
|
|
61
|
+
```html
|
|
62
|
+
<div class="fd-tool-layout">
|
|
63
|
+
|
|
64
|
+
</div>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Modifiers
|
|
68
|
+
|
|
69
|
+
| Class | Description |
|
|
70
|
+
|-------|-------------|
|
|
71
|
+
| `fd-tool-layout--horizontal-navigation` | Style variant |
|
|
72
|
+
| `fd-tool-layout--phone` | Apply the <code>fd-tool-layout--phone</code> modifier class for mobile devices. |
|
|
73
|
+
| `fd-tool-layout--sticky` | The <code>fd-tool-layout--sticky</code> modifier class will position the whole layout absolutely with the header container always on top |
|
|
74
|
+
| `fd-tool-layout--tablet` | Apply the <code>fd-tool-layout--tablet</code> modifier class for tablet devices. |
|
|
75
|
+
|
|
76
|
+
## BEM Elements
|
|
77
|
+
|
|
78
|
+
This component uses the following BEM elements:
|
|
79
|
+
|
|
80
|
+
- `fd-tool-layout__container`
|
|
81
|
+
- `fd-tool-layout__content-container`
|
|
82
|
+
- `fd-tool-layout__header-container`
|
|
83
|
+
- `fd-tool-layout__navigation-container`
|
|
84
|
+
- `fd-tool-layout__navigation-container--horizontal`
|
|
85
|
+
|
|
86
|
+
## Component Structure
|
|
87
|
+
|
|
88
|
+
- <code>.fd-tool-layout</code>
|
|
89
|
+
- <code>.fd-tool-layout--tablet</code> - modifier class for tablets
|
|
90
|
+
- <code>.fd-tool-layout--phone</code> - modifier class for phones
|
|
91
|
+
- <code>.fd-tool-layout--sticky</code> - modifier class for positioning the header on the top
|
|
92
|
+
- <code>.fd-tool-layout--horizontal-navigation</code> - modifier class for layout with Horizontal Navigation
|
|
93
|
+
- <code>.fd-tool-layout\\_\\_container</code>
|
|
94
|
+
- <code>.fd-tool-layout\\_\\_header-container</code> - wraping element around the Tool Header
|
|
95
|
+
- <code>.fd-tool-layout\\_\\_navigation-container</code> - wraping element around the Navigation (all its variants)
|
|
96
|
+
- <code>.fd-tool-layout\\_\\_navigation-container--horizontal</code> - modifier class for when the navigation is horizontal
|
|
97
|
+
- <code>.fd-tool-layout\\_\\_content-container</code> - wraping element around the page content. By default, the background of the content area is <code>var(--sapBackgroundColor)</code>
|
|
98
|
+
- <code>.fd-tool-layout\\_\\_content-container--transparent</code> - modifier class to apply transparent background to the content area.
|
|
99
|
+
- <code>.fd-tool-layout\\_\\_content-container--list</code> - modifier class to apply list <code>var(--sapGroup_ContentBackground)</code> background to the content area.
|
|
100
|
+
|
|
101
|
+
## Related Components
|
|
102
|
+
|
|
103
|
+
This component works with or depends on:
|
|
104
|
+
|
|
105
|
+
- `tool-layout`
|
|
106
|
+
|
|
107
|
+
## Design Tokens
|
|
108
|
+
|
|
109
|
+
Key CSS variables used by this component:
|
|
110
|
+
|
|
111
|
+
- `--fdToolLayout_Background`
|
|
112
|
+
- `--fdToolLayout_Content_Container_Background`
|
|
113
|
+
- `--fdToolLayout_Content_Container_Border_Radius`
|
|
114
|
+
- `--fdToolLayout_Content_Container_BoxShadow`
|
|
115
|
+
- `--fdToolLayout_Gap`
|
|
116
|
+
- `--fdToolLayout_Padding_Block`
|
|
117
|
+
- `--fdToolLayout_Padding_Inline`
|
|
118
|
+
- `--horizontal`
|
|
119
|
+
- `--horizontal-navigation`
|
|
120
|
+
- `--list`
|
|
121
|
+
- `--phone`
|
|
122
|
+
- `--sapBackgroundColor`
|
|
123
|
+
- `--sapContent_Shadow0`
|
|
124
|
+
- `--sapGroup_ContentBackground`
|
|
125
|
+
- `--sticky`
|
|
126
|
+
|
|
127
|
+
*...and 2 more*
|
|
128
|
+
|
|
129
|
+
## Examples
|
|
130
|
+
|
|
131
|
+
### Desktop
|
|
132
|
+
|
|
133
|
+
```html
|
|
134
|
+
<div class="fd-tool-layout">
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Sticky
|
|
140
|
+
|
|
141
|
+
The <code>fd-tool-layout--sticky</code> modifier class will position the whole layout absolutely with the header container always on top. The navigation and content containers receive the scroll overflow.
|
|
142
|
+
|
|
143
|
+
```html
|
|
144
|
+
<div class="fd-tool-layout fd-tool-layout--sticky">
|
|
145
|
+
<div class="fd-tool-layout__container">
|
|
146
|
+
|
|
147
|
+
<div class="fd-tool-layout__container">
|
|
148
|
+
|
|
149
|
+
<div class="fd-tool-layout__content-container">
|
|
150
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.
|
|
151
|
+
</div>
|
|
152
|
+
</div>
|
|
153
|
+
</div>
|
|
154
|
+
</div>
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Tablet
|
|
158
|
+
|
|
159
|
+
Apply the <code>fd-tool-layout--tablet</code> modifier class for tablet devices.
|
|
160
|
+
|
|
161
|
+
```html
|
|
162
|
+
<h4>With Vertical Navigation</h4>
|
|
163
|
+
<div class="fd-tool-layout fd-tool-layout--tablet">
|
|
164
|
+
<div class="fd-tool-layout__container">
|
|
165
|
+
|
|
166
|
+
</div>
|
|
167
|
+
</div>
|
|
168
|
+
<h4>With Horizontal Navigation</h4>
|
|
169
|
+
<div class="fd-tool-layout fd-tool-layout--tablet fd-tool-layout--horizontal-navigation">
|
|
170
|
+
<div class="fd-tool-layout__container">
|
|
171
|
+
|
|
172
|
+
</div>
|
|
173
|
+
</div>
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Mobile
|
|
177
|
+
|
|
178
|
+
Apply the <code>fd-tool-layout--phone</code> modifier class for mobile devices.
|
|
179
|
+
|
|
180
|
+
```html
|
|
181
|
+
<div class="fd-tool-layout fd-tool-layout--phone">
|
|
182
|
+
<div class="fd-tool-layout__container">
|
|
183
|
+
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## Accessibility
|
|
189
|
+
|
|
190
|
+
- Use semantic HTML elements where appropriate
|
|
191
|
+
- Include proper ARIA attributes for interactive elements
|
|
192
|
+
- Ensure keyboard navigation support
|
|
193
|
+
- Provide adequate color contrast
|
|
194
|
+
|
|
195
|
+
## Source
|
|
196
|
+
|
|
197
|
+
This documentation was automatically generated from: `packages/styles/stories/Layouts/tool-layout/tool-layout.stories.js`
|
|
198
|
+
|
|
199
|
+
For the latest updates and interactive examples, see [Storybook](https://sap.github.io/fundamental-styles/).
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: fd-toolbar
|
|
3
|
+
title: AI/Patterns/Writing Assistant Toolbar
|
|
4
|
+
category: AI
|
|
5
|
+
selector: fd-toolbar
|
|
6
|
+
cssFile: toolbar.css
|
|
7
|
+
sourcePath: packages/styles/stories/AI/Patterns/ai-writing-assistant-toolbar/ai-writing-assistant-toolbar.stories.js
|
|
8
|
+
tags: ["ai","experimental"]
|
|
9
|
+
dependencies: []
|
|
10
|
+
relatedComponents: []
|
|
11
|
+
stability: experimental
|
|
12
|
+
generatedAt: 2026-06-09T18:29:01.791Z
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# AI/Patterns/Writing Assistant Toolbar
|
|
16
|
+
|
|
17
|
+
> **🧪 EXPERIMENTAL**: This component is experimental and its API may change.
|
|
18
|
+
|
|
19
|
+
The AI writing assistant toolbar is part of AI writing assistant pattern for text areas and rich text editors. It allows users to access AI writing assistant capabilities within Text Areas and Rich Text Editor.
|
|
20
|
+
|
|
21
|
+
<b>Anatomy:</b><br>
|
|
22
|
+
AI Writing Assistant Toolbar extends the toolbar component to enable new AI-specific interactions and is composed by:
|
|
23
|
+
<br>
|
|
24
|
+
<ul>
|
|
25
|
+
<li>Toolbar Container: Embedded at the bottom of the Text Area or Rich Text Editor, the toolbar spans the entire width of the parent component.</li>
|
|
26
|
+
<li>AI Icon Menu Button: Positioned on the right side of the AI toolbar, it indicates AI writing assistance and provides a menu with AI prompts for fine-tuning the content.</li>
|
|
27
|
+
<li>Performed AI Prompt: Uses the label component to display the AI prompt applied to this version of the content is shown to the right of the versioning element.</li>
|
|
28
|
+
<li>Versioning: Positioned within the AI writing assistant toolbar, it includes:
|
|
29
|
+
<ul>
|
|
30
|
+
<li>previous version icon for navigation</li>
|
|
31
|
+
<li>version indicator</li>
|
|
32
|
+
<li>next version icon for navigation</li>
|
|
33
|
+
</ul>
|
|
34
|
+
This versioning feature allows users to view different versions of AI-generated content.
|
|
35
|
+
</li>
|
|
36
|
+
</ul>
|
|
37
|
+
|
|
38
|
+
<br><b>Note: The component is in an experimental state.</b>
|
|
39
|
+
|
|
40
|
+
## Installation
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm install fundamental-styles
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```html
|
|
47
|
+
<!-- Include theme -->
|
|
48
|
+
<link href="node_modules/fundamental-styles/dist/theming/sap_horizon.css" rel="stylesheet">
|
|
49
|
+
|
|
50
|
+
<!-- Include component CSS -->
|
|
51
|
+
<link href="node_modules/fundamental-styles/dist/toolbar.css" rel="stylesheet">
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Basic Usage
|
|
56
|
+
|
|
57
|
+
```html
|
|
58
|
+
<div class="fd-toolbar fd-toolbar--ai" role="toolbar" aria-label="AI toolbar">
|
|
59
|
+
<span class="fd-toolbar__spacer"></span>
|
|
60
|
+
<button class="fd-button fd-button--transparent" aria-label="AI writing Assistant" title="AI writing Assistant (Shift+F4)">
|
|
61
|
+
<i class="sap-icon--ai"></i>
|
|
62
|
+
</button>
|
|
63
|
+
</div>
|
|
64
|
+
<h4>Loading</h4>
|
|
65
|
+
<div class="fd-toolbar fd-toolbar--ai is-active" role="toolbar" aria-label="AI toolbar">
|
|
66
|
+
<label class="fd-form-label fd-form-label--stand-alone">Performing AI Prompt</label>
|
|
67
|
+
<span class="fd-toolbar__spacer"></span>
|
|
68
|
+
<button class="fd-button fd-button--transparent" aria-label="AI writing assistant generating" title="Stop Generating (Esc)">
|
|
69
|
+
<i class="sap-icon--stop"></i>
|
|
70
|
+
</button>
|
|
71
|
+
</div>
|
|
72
|
+
<h4>No versioning</h4>
|
|
73
|
+
<div class="fd-toolbar fd-toolbar--ai is-active" role="toolbar" aria-label="AI toolbar">
|
|
74
|
+
<label class="fd-form-label fd-form-label--stand-alone">Performed AI Prompt</label>
|
|
75
|
+
<span class="fd-toolbar__spacer"></span>
|
|
76
|
+
<button class="fd-button fd-button--transparent" aria-label="AI Writing Assistant" title="AI writing Assistant (Shift+F4)">
|
|
77
|
+
<i class="sap-icon--ai"></i>
|
|
78
|
+
</button>
|
|
79
|
+
</div>
|
|
80
|
+
<h4>Versioning</h4>
|
|
81
|
+
<div class="fd-toolbar fd-toolbar--ai is-active" role="toolbar" aria-label="AI toolbar">
|
|
82
|
+
<div class="fd-ai-writing-assistant-versioning">
|
|
83
|
+
<button aria-label="Previous Version" title="Previous Version (Shift+Ctrl+Z)" class="fd-button fd-button--transparent">
|
|
84
|
+
<i class="sap-icon--navigation-left-arrow"></i>
|
|
85
|
+
</button>
|
|
86
|
+
<label class="fd-form-label fd-form-label--stand-alone">3 / 3</label>
|
|
87
|
+
<button aria-label="Next Version" title="Next Version (Shift+Ctrl+Y)" class="fd-button fd-button--transparent" disabled>
|
|
88
|
+
<i class="sap-icon--navigation-right-arrow"></i>
|
|
89
|
+
</button>
|
|
90
|
+
</div>
|
|
91
|
+
<label class="fd-form-label fd-form-label--stand-alone">Performed AI Prompt</label>
|
|
92
|
+
<span class="fd-toolbar__spacer"></span>
|
|
93
|
+
<button class="fd-button fd-button--transparent" aria-label="AI Writing Assistant" title="AI writing Assistant (Shift+F4)">
|
|
94
|
+
<i class="sap-icon--ai"></i>
|
|
95
|
+
</button>
|
|
96
|
+
</div>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Modifiers
|
|
100
|
+
|
|
101
|
+
| Class | Description |
|
|
102
|
+
|-------|-------------|
|
|
103
|
+
| `fd-toolbar--ai` | Style variant |
|
|
104
|
+
|
|
105
|
+
## States
|
|
106
|
+
|
|
107
|
+
| Class | Description |
|
|
108
|
+
|-------|-------------|
|
|
109
|
+
| `is-active` | Active state |
|
|
110
|
+
|
|
111
|
+
## BEM Elements
|
|
112
|
+
|
|
113
|
+
This component uses the following BEM elements:
|
|
114
|
+
|
|
115
|
+
- `fd-toolbar__spacer`
|
|
116
|
+
|
|
117
|
+
## Examples
|
|
118
|
+
|
|
119
|
+
### AIWritingAssistantToolbar
|
|
120
|
+
|
|
121
|
+
```html
|
|
122
|
+
<div class="fd-toolbar fd-toolbar--ai" role="toolbar" aria-label="AI toolbar">
|
|
123
|
+
<span class="fd-toolbar__spacer"></span>
|
|
124
|
+
<button class="fd-button fd-button--transparent" aria-label="AI writing Assistant" title="AI writing Assistant (Shift+F4)">
|
|
125
|
+
<i class="sap-icon--ai"></i>
|
|
126
|
+
</button>
|
|
127
|
+
</div>
|
|
128
|
+
<h4>Loading</h4>
|
|
129
|
+
<div class="fd-toolbar fd-toolbar--ai is-active" role="toolbar" aria-label="AI toolbar">
|
|
130
|
+
<label class="fd-form-label fd-form-label--stand-alone">Performing AI Prompt</label>
|
|
131
|
+
<span class="fd-toolbar__spacer"></span>
|
|
132
|
+
<button class="fd-button fd-button--transparent" aria-label="AI writing assistant generating" title="Stop Generating (Esc)">
|
|
133
|
+
<i class="sap-icon--stop"></i>
|
|
134
|
+
</button>
|
|
135
|
+
</div>
|
|
136
|
+
<h4>No versioning</h4>
|
|
137
|
+
<div class="fd-toolbar fd-toolbar--ai is-active" role="toolbar" aria-label="AI toolbar">
|
|
138
|
+
<label class="fd-form-label fd-form-label--stand-alone">Performed AI Prompt</label>
|
|
139
|
+
<span class="fd-toolbar__spacer"></span>
|
|
140
|
+
<button class="fd-button fd-button--transparent" aria-label="AI Writing Assistant" title="AI writing Assistant (Shift+F4)">
|
|
141
|
+
<i class="sap-icon--ai"></i>
|
|
142
|
+
</button>
|
|
143
|
+
</div>
|
|
144
|
+
<h4>Versioning</h4>
|
|
145
|
+
<div class="fd-toolbar fd-toolbar--ai is-active" role="toolbar" aria-label="AI toolbar">
|
|
146
|
+
<div class="fd-ai-writing-assistant-versioning">
|
|
147
|
+
<button aria-label="Previous Version" title="Previous Version (Shift+Ctrl+Z)" class="fd-button fd-button--transparent">
|
|
148
|
+
<i class="sap-icon--navigation-left-arrow"></i>
|
|
149
|
+
</button>
|
|
150
|
+
<label class="fd-form-label fd-form-label--stand-alone">3 / 3</label>
|
|
151
|
+
<button aria-label="Next Version" title="Next Version (Shift+Ctrl+Y)" class="fd-button fd-button--transparent" disabled>
|
|
152
|
+
<i class="sap-icon--navigation-right-arrow"></i>
|
|
153
|
+
</button>
|
|
154
|
+
</div>
|
|
155
|
+
<label class="fd-form-label fd-form-label--stand-alone">Performed AI Prompt</label>
|
|
156
|
+
<span class="fd-toolbar__spacer"></span>
|
|
157
|
+
<button class="fd-button fd-button--transparent" aria-label="AI Writing Assistant" title="AI writing Assistant (Shift+F4)">
|
|
158
|
+
<i class="sap-icon--ai"></i>
|
|
159
|
+
</button>
|
|
160
|
+
</div>
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## Accessibility
|
|
164
|
+
|
|
165
|
+
- Use semantic HTML elements where appropriate
|
|
166
|
+
- Include proper ARIA attributes for interactive elements
|
|
167
|
+
- Ensure keyboard navigation support
|
|
168
|
+
- Provide adequate color contrast
|
|
169
|
+
|
|
170
|
+
## Source
|
|
171
|
+
|
|
172
|
+
This documentation was automatically generated from: `packages/styles/stories/AI/Patterns/ai-writing-assistant-toolbar/ai-writing-assistant-toolbar.stories.js`
|
|
173
|
+
|
|
174
|
+
For the latest updates and interactive examples, see [Storybook](https://sap.github.io/fundamental-styles/).
|