-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathmkdocs.yml
More file actions
267 lines (257 loc) · 15.3 KB
/
mkdocs.yml
File metadata and controls
267 lines (257 loc) · 15.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
site_name: Siemens Element Documentation
site_author: 'Siemens'
site_url: 'https://element.siemens.io/'
site_dir: 'dist/design'
repo_name: 'siemens/element'
repo_url: 'https://github.com/siemens/element'
edit_uri: 'blob/main/docs/'
copyright: '© Siemens 2016-2026'
strict: true
nav:
- Home:
- Overview: 'README.md'
- Get started: 'get-started/quickstart.md'
- Build with AI: 'get-started/element-mcp.md'
- Update guides:
- Update to v49: 'update-guides/update-v49.md'
- Changelog: 'CHANGELOG.md'
- Fundamentals:
- Typography: 'fundamentals/typography.md'
- Colors:
- Color palette: 'fundamentals/colors/color-palette.md'
- UI colors: 'fundamentals/colors/ui-colors.md'
- Data visualization colors: 'fundamentals/colors/data-visualization-colors.md'
- Shapes: 'fundamentals/shapes.md'
- Illustrations: 'fundamentals/illustrations.md'
- Layouts:
- Overview: 'fundamentals/layouts/overview.md'
- Breakpoints: 'fundamentals/layouts/breakpoints.md'
- Flexbox grid: 'fundamentals/layouts/grid.md'
- Gutters: 'fundamentals/layouts/gutters.md'
- Spacing: 'fundamentals/layouts/spacing.md'
- Anatomy: 'fundamentals/layouts/anatomy.md'
- Header: 'fundamentals/layouts/header.md'
- Content: 'fundamentals/layouts/content.md'
- Elevation: 'fundamentals/elevation.md'
- Icons: 'fundamentals/icons.md'
- Localization: 'fundamentals/localization.md'
- Styles:
- Borders: 'fundamentals/styles/borders.md'
- Colors: 'fundamentals/styles/colors.md'
- Display: 'fundamentals/styles/display.md'
- Flex: 'fundamentals/styles/flex.md'
- Interactions: 'fundamentals/styles/interactions.md'
- Overflow: 'fundamentals/styles/overflow.md'
- Position: 'fundamentals/styles/position.md'
- Sizing: 'fundamentals/styles/sizing.md'
- Text: 'fundamentals/styles/text.md'
- Visibility: 'fundamentals/styles/visibility.md'
- Z-Index: 'fundamentals/styles/z-index.md'
- UX writing:
- Overview: 'fundamentals/ux-text-style-guide/index.md'
- Basics: 'fundamentals/ux-text-style-guide/basics.md'
- Grammar and vocabulary: 'fundamentals/ux-text-style-guide/grammar-and-vocabulary.md'
- Punctuation: 'fundamentals/ux-text-style-guide/punctuation.md'
- Proper nouns: 'fundamentals/ux-text-style-guide/proper-nouns.md'
- Main menu functions: 'fundamentals/ux-text-style-guide/main-menu-functions.md'
- Frequent app functions: 'fundamentals/ux-text-style-guide/frequent-app-functions.md'
- Inappropriate terms: 'fundamentals/ux-text-style-guide/inappropriate-terms.md'
- Best practices: 'fundamentals/ux-text-style-guide/best-practices.md'
- Errors, warnings and notifications: 'fundamentals/ux-text-style-guide/error-messages.md'
- Dialogs and buttons: 'fundamentals/ux-text-style-guide/dialogs-and-buttons.md'
- Components:
- Overview: 'components/index.md'
- Buttons & menus:
- Buttons: 'components/buttons-menus/buttons.md'
- Button group: 'components/buttons-menus/button-group.md'
- Content action bar: 'components/buttons-menus/content-actions.md'
- Dropdowns: 'components/buttons-menus/dropdowns.md'
- Help button: 'components/buttons-menus/help-button.md'
- Links: 'components/buttons-menus/links.md'
- Menu: 'components/buttons-menus/menu.md'
- Dashboards:
- Overview: 'components/dashboards/index.md'
- Dashboard: 'components/dashboards/dashboard.md'
- Flexible dashboards: 'components/dashboards/flexible-dashboards.md'
- Link widget: 'components/dashboards/link-widget.md'
- List widget: 'components/dashboards/list-widget.md'
- Timeline widget: 'components/dashboards/timeline-widget.md'
- Value widget: 'components/dashboards/value-widget.md'
- Forms & inputs:
- Checkbox: 'components/forms-inputs/checkbox.md'
- Color picker: 'components/forms-inputs/color-picker.md'
- Date & time: 'components/forms-inputs/datepicker.md'
- Date range filter: 'components/forms-inputs/date-range-filter.md'
- File uploader: 'components/forms-inputs/file-uploader.md'
- Forms: 'components/forms-inputs/forms.md'
- Input: 'components/forms-inputs/input.md'
- IP input: 'components/forms-inputs/ip-input.md'
- Language switcher: 'components/forms-inputs/language-switcher.md'
- Number input: 'components/forms-inputs/number-input.md'
- Phone number input: 'components/forms-inputs/phone-number-input.md'
- Pills input: 'components/forms-inputs/pills-input.md'
- Photo uploader: 'components/forms-inputs/photo-upload.md'
- Radio: 'components/forms-inputs/radio.md'
- Select: 'components/forms-inputs/select.md'
- Slider: 'components/forms-inputs/slider.md'
- Switch: 'components/forms-inputs/switch.md'
- Text area: 'components/forms-inputs/text-area.md'
- Threshold: 'components/forms-inputs/threshold.md'
- Layout & navigation:
- Accordion: 'components/layout-navigation/accordion.md'
- Application header: 'components/layout-navigation/application-header.md'
- Breadcrumb: 'components/layout-navigation/breadcrumb.md'
- Card: 'components/layout-navigation/cards.md'
- Electron titlebar: 'components/layout-navigation/electron-titlebar.md'
- Footer: 'components/layout-navigation/footer.md'
- Launchpad: 'components/layout-navigation/launchpad.md'
- List-details: 'components/layout-navigation/list-details.md'
- Modals: 'components/layout-navigation/modals.md'
- Pagination: 'components/layout-navigation/pagination.md'
- Side panel: 'components/layout-navigation/side-panel.md'
- Split: 'components/layout-navigation/split.md'
- Tabs: 'components/layout-navigation/tabs.md'
- Tour: 'components/layout-navigation/tour.md'
- Vertical navigation: 'components/layout-navigation/vertical-navigation.md'
- Wizard: 'components/layout-navigation/wizard.md'
- Lists, tables & trees:
- List group: 'components/lists-tables-trees/list-group.md'
- Table & datatable: 'components/lists-tables-trees/datatable.md'
- Tree view: 'components/lists-tables-trees/tree-view.md'
- Progress indications:
- Progress bar: 'components/progress-indication/progress-bar.md'
- Result details list: 'components/progress-indication/result-details-list.md'
- Skeleton: 'components/progress-indication/skeleton.md'
- Spinner: 'components/progress-indication/spinner.md'
- Search, filter & sort:
- Overview: 'components/sorting-filtering/index.md'
- Search bar: 'components/sorting-filtering/search-bar.md'
- Sort bar: 'components/sorting-filtering/sort-bar.md'
- Typeahead: 'components/sorting-filtering/typeahead.md'
- Filter bar: 'components/sorting-filtering/filter-bar.md'
- Filter pills: 'components/sorting-filtering/filter-pills.md'
- Filtered search: 'components/sorting-filtering/filtered-search.md'
- Status & notifications:
- Avatar: 'components/status-notifications/avatar.md'
- Badges: 'components/status-notifications/badges.md'
- Circle status: 'components/status-notifications/circle-status.md'
- Connection strength: 'components/status-notifications/connection-strength.md'
- Copyright notice: 'components/status-notifications/copyright-notice.md'
- Empty state: 'components/status-notifications/empty-state.md'
- Icon: 'components/status-notifications/icon.md'
- Inline notification: 'components/status-notifications/inline-notification.md'
- Notification item: 'components/status-notifications/notification-item.md'
- Popover: 'components/status-notifications/popover.md'
- Status bar: 'components/status-notifications/status-bar.md'
- Status toggle: 'components/status-notifications/status-toggle.md'
- Status counter: 'components/status-notifications/status-counter.md'
- Summary chip: 'components/status-notifications/summary-chip.md'
- Summary widget: 'components/status-notifications/summary-widget.md'
- System banner: 'components/status-notifications/system-banner.md'
- Toast notification: 'components/status-notifications/toast-notification.md'
- Tooltip: 'components/status-notifications/tooltip.md'
- Chat & messages:
- Chat input: 'components/chat-messages/chat-input.md'
- Chat message: 'components/chat-messages/chat-message.md'
- Charts:
- Overview: 'components/charts/index.md'
- Bar chart: 'components/charts/bar-chart.md'
- Circle chart: 'components/charts/circle-chart.md'
- Gauge chart: 'components/charts/gauge-chart.md'
- Line chart: 'components/charts/line-chart.md'
- Progress chart: 'components/charts/progress-chart.md'
- Scatter chart: 'components/charts/scatter-chart.md'
- Generic chart: 'components/charts/generic-chart.md'
- Micro charts: 'components/charts/micro-charts.md'
- Maps: 'components/maps/maps.md'
- Pages:
- About: 'components/pages/about.md'
- Info Page: 'components/pages/info-page.md'
- Landing Page: 'components/pages/landing-page.md'
- Icons: 'icons.md'
- Patterns:
- Overview: 'patterns/index.md'
- Backdrop: 'patterns/backdrop.md'
- Drag & drop: 'patterns/drag-and-drop.md'
- Loading: 'patterns/loading.md'
- Notifications: 'patterns/notifications.md'
- Filter: 'patterns/filter.md'
- Help: 'patterns/help.md'
- AI:
- Overview: 'patterns/ai/overview.md'
- AI chat: 'patterns/ai/ai-chat.md'
- Architecture:
- CSS framework: 'architecture/css-framework.md'
- Dynamic forms: 'architecture/dynamic-forms.md'
- Motion and animation: 'architecture/motion-animation.md'
- Resize observer: 'architecture/resize-observer.md'
- Theming: 'architecture/theming.md'
- UI state: 'architecture/ui-state.md'
- Contributing:
- Guidelines: 'CONTRIBUTING.md'
- Code of conduct: 'CODE_OF_CONDUCT.md'
- Developer guide: 'DEVELOPER.md'
theme:
name: code-siemens-code-docs-theme
palette:
- media: "(prefers-color-scheme: dark)"
scheme: dark
toggle:
icon: siemens/element/element-economy
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: light
toggle:
icon: siemens/element/element-sun
name: Switch to system theme
- media: "(prefers-color-scheme)"
toggle:
icon: siemens/element/element-theme-auto
name: Switch to dark mode
favicon: '_src/favicon.png'
custom_dir: docs/_custom_theme
features:
- navigation.tabs
- page.toc
- content.action.edit
- content.code.copy
extra_css:
- '_src/dos-and-donts.css'
- '_src/color-grid.css'
extra_javascript:
- '//w3.siemens.com/ote/ote_config.js'
- '//w3.siemens.com/ote/sinet/ote.js'
- 'https://assets.adobedtm.com/5dfc7d97c6fb/f16b45bec907/launch-af252bb19983.min.js'
- '_src/version-selector.js'
extra:
links:
- name: 'GitHub'
value: 'https://github.com/siemens/element'
- name: 'Siemens Xcelerator Developer Portal'
value: 'https://developer.siemens.com/'
page_license_text: Except where otherwise noted, content on this site is licensed under <a href="https://github.com/siemens/element/blob/main/LICENSE.md">MIT License</a>.
markdown_extensions:
- attr_list
- pymdownx.highlight:
linenums: true
linenums_style: pymdownx-inline
guess_lang: true
- pymdownx.emoji:
emoji_index: !!python/name:mkdocs_siemens.icons.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.details
- pymdownx.tasklist
- pymdownx.tilde
- pymdownx.snippets
- pymdownx.superfences
- admonition
- md_in_html
- element-docs:
examples_base: !ENV [ EXAMPLES_BASE, 'http://localhost:4200' ]
md_file: !relative
- toc:
permalink: true
plugins:
- material/search
- minify_html
- element-docs-builder