@covalent/markdown-navigator 11.6.6 → 11.6.8

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/README.md CHANGED
@@ -64,21 +64,29 @@ export class MyModule {}
64
64
 
65
65
  ## Covalent Icons Support (Optional)
66
66
 
67
- The Markdown Navigator component supports both **Material Icons** (default) and **Covalent Icons** (optional).
67
+ The Markdown Navigator automatically detects Covalent Icons and applies the correct font styling. Covalent Icons are **completely optional** - the component works perfectly with Material Icons only.
68
68
 
69
- ### Using with Covalent Design System
69
+ ### Icon Detection (Built-in)
70
70
 
71
- If your project already uses other Covalent components and has the following in your global styles:
71
+ The component includes icon detection out-of-the-box. **No additional setup or installation required.**
72
+
73
+ Icon detection is bundled within the component and works with any version of `@covalent/icons` installed in your project.
74
+
75
+ ### Rendering Covalent Icons (Optional)
76
+
77
+ If you want to **render** Covalent Icons (not just Material Icons), you need to install the icon fonts:
78
+
79
+ **Option 1: Using with Covalent Design System**
80
+
81
+ If your project already uses other Covalent components with the following in your global styles:
72
82
 
73
83
  ```scss
74
84
  @use '@covalent/icons';
75
85
  ```
76
86
 
77
- **You don't need to do anything additional.** Covalent Icons will work automatically.
78
-
79
- ### Using Markdown Navigator Standalone
87
+ Covalent Icons will work automatically.
80
88
 
81
- If you're using the Markdown Navigator component without the full Covalent Design System:
89
+ **Option 2: Standalone Installation**
82
90
 
83
91
  1. **Install the icons package:**
84
92
 
@@ -91,32 +99,25 @@ If you're using the Markdown Navigator component without the full Covalent Desig
91
99
  @import '@covalent/markdown-navigator/styles/markdown-navigator-icons.scss';
92
100
  ```
93
101
 
94
- ### Without Covalent Icons
95
-
96
- The component works perfectly with **Material Icons only**. Covalent Icons are completely optional.
97
-
98
102
  ### Icon Usage
99
103
 
100
- You can specify icons in your items using:
104
+ Both icon types work the same way in your data:
101
105
 
102
- - **Material Icons:** Use the icon name directly
106
+ ```typescript
107
+ // Material Icons (always available via Google Fonts)
108
+ {
109
+ title: 'Notebooks',
110
+ icon: 'book',
111
+ }
103
112
 
104
- ```typescript
105
- {
106
- title: 'Notebooks',
107
- icon: 'book', // Material Icon
108
- // ...
109
- }
110
- ```
113
+ // Covalent Icons (requires @covalent/icons for rendering)
114
+ {
115
+ title: 'Vector Store',
116
+ icon: 'variable_outlined', // Auto-detected as Covalent icon
117
+ }
118
+ ```
111
119
 
112
- - **Covalent Icons:** Use the icon name (the component auto-detects Covalent icons)
113
- ```typescript
114
- {
115
- title: 'Vector Store',
116
- icon: 'variable_outlined', // Covalent Icon
117
- // ...
118
- }
119
- ```
120
+ **Note:** If a Covalent icon is used but `@covalent/icons` is not installed, the icon will display as an empty box. Material Icons always work without additional setup.
120
121
 
121
122
  The component automatically detects which font to use based on the icon name. No additional configuration needed in your TypeScript code.
122
123
 
@@ -20,318 +20,6 @@ import { TdMessageComponent } from '@covalent/core/message';
20
20
  import { TdBreadcrumbsComponent, TdBreadcrumbComponent } from '@covalent/core/breadcrumbs';
21
21
  import { TdWindowDialogComponent, TdDialogService, ResizableDraggableDialog } from '@covalent/core/dialogs';
22
22
 
23
- const COV_ICON_LIST = [
24
- 'advanced_sql',
25
- 'advanced_sql_outlined',
26
- 'ai_assistant',
27
- 'alias_arrow',
28
- 'alias_arrow_outlined',
29
- 'api',
30
- 'api_outlined',
31
- 'api_ondark',
32
- 'application',
33
- 'application_outlined',
34
- 'attribution',
35
- 'attribution_outlined',
36
- 'auto_refresh_off',
37
- 'auto_refresh_off_outlined',
38
- 'auto_refresh_on',
39
- 'auto_refresh_on_outlined',
40
- 'autorefresh_pause',
41
- 'autorefresh_pause_outlined',
42
- 'autorenew_on',
43
- 'autorenew_on_outlined',
44
- 'autorenew_off',
45
- 'autorenew_off_outlined',
46
- 'branch',
47
- 'branch_outlined',
48
- 'bucket',
49
- 'bucket_outlined',
50
- 'cluster_analysis',
51
- 'cluster_analysis_outlined',
52
- 'code_deployed',
53
- 'code_deployed_outlined',
54
- 'code_deployed_retired',
55
- 'code_deployed_retired_outlined',
56
- 'code_fork',
57
- 'code_fork_outlined',
58
- 'column',
59
- 'column_outlined',
60
- 'compute_cluster',
61
- 'compute_cluster_outlined',
62
- 'compute_cluster_group',
63
- 'compute_cluster_group_outlined',
64
- 'compute_groups',
65
- 'compute_groups_outlined',
66
- 'compute_profile',
67
- 'compute_profile_outlined',
68
- 'compute_profile_dark',
69
- 'compute_profile_light',
70
- 'connected_identity',
71
- 'connected_identity_outlined',
72
- 'created_document',
73
- 'created_document_outlined',
74
- 'data_management',
75
- 'data_management_outlined',
76
- 'data_preparation',
77
- 'data_preparation_outlined',
78
- 'data_protection',
79
- 'data_protection_outlined',
80
- 'data_sharing',
81
- 'data_sharing_outlined',
82
- 'data_source',
83
- 'data_source_outlined',
84
- 'data_source_type_amazon',
85
- 'data_source_type_amazon_outlined',
86
- 'data_source_type_azure',
87
- 'data_source_type_azure_outlined',
88
- 'data_source_type_cloudera',
89
- 'data_source_type_cloudera_outlined',
90
- 'data_source_type_hdinsight',
91
- 'data_source_type_hdinsight_outlined',
92
- 'data_source_type_microsoft',
93
- 'data_source_type_microsoft_outlined',
94
- 'data_source_type_teradata',
95
- 'data_source_type_teradata_outlined',
96
- 'data_transformation_services',
97
- 'data_transformation_services_outlined',
98
- 'database',
99
- 'database_outlined',
100
- 'database_changed',
101
- 'database_changed_outlined',
102
- 'database_edit',
103
- 'database_edit_outlined',
104
- 'database_foreign',
105
- 'database_foreign_outlined',
106
- 'database_lab',
107
- 'database_lab_outlined',
108
- 'database_none',
109
- 'database_none_outlined',
110
- 'database_search',
111
- 'database_search_outlined',
112
- 'database_synced',
113
- 'database_synced_outlined',
114
- 'database_unreachable',
115
- 'database_unreachable_outlined',
116
- 'disconnect',
117
- 'dock_right',
118
- 'dock_right_outlined',
119
- 'embedding_model',
120
- 'engine',
121
- 'engine_outlined',
122
- 'engine_sql',
123
- 'engine_sql_outlined',
124
- 'file',
125
- 'file_outlined',
126
- 'file_changed',
127
- 'file_changed_outlined',
128
- 'file_edit',
129
- 'file_edit_outlined',
130
- 'file_foreign',
131
- 'file_foreign_outlined',
132
- 'file_lab',
133
- 'file_lab_outlined',
134
- 'file_search',
135
- 'file_search_outlined',
136
- 'file_synced',
137
- 'file_synced_outlined',
138
- 'filter_clear',
139
- 'filter_clear_outlined',
140
- 'formula',
141
- 'formula_outlined',
142
- 'lab',
143
- 'lab_outlined',
144
- 'loader_dots',
145
- 'machine_learning',
146
- 'machine_learning_outlined',
147
- 'machine_learning_ondark',
148
- 'managed_services',
149
- 'managed_services_outlined',
150
- 'merge',
151
- 'merge_outlined',
152
- 'model',
153
- 'model_outlined',
154
- 'model_ondark',
155
- 'model_configuration',
156
- 'model_configuration_outlined',
157
- 'model_configuration_ondark',
158
- 'no_results',
159
- 'no_results_outlined',
160
- 'node_branch',
161
- 'node_merge',
162
- 'node_notification',
163
- 'node_notification_outlined',
164
- 'node_notification_ondark',
165
- 'nos',
166
- 'nos_outlined',
167
- 'object_browser_view',
168
- 'object_browser_view_outlined',
169
- 'object_storage',
170
- 'object_storage_outlined',
171
- 'object_storage_ondark',
172
- 'operations',
173
- 'operations_outlined',
174
- 'operators_divide',
175
- 'operators_divide_outlined',
176
- 'operators_equals',
177
- 'operators_equals_outlined',
178
- 'operators_greater_than',
179
- 'operators_greater_than_outlined',
180
- 'operators_greater_than_or_equal',
181
- 'operators_greater_than_or_equal_outlined',
182
- 'operators_less_than',
183
- 'operators_less_than_outlined',
184
- 'operators_less_than_or_equal',
185
- 'operators_less_than_or_equal_outlined',
186
- 'operators_multiply',
187
- 'operators_multiply_outlined',
188
- 'operators_not_equal',
189
- 'operators_not_equal_outlined',
190
- 'operators_parentheses',
191
- 'operators_parentheses_outlined',
192
- 'operators_parenthesis_left',
193
- 'operators_parenthesis_left_outlined',
194
- 'operators_parenthesis_right',
195
- 'operators_parenthesis_right_outlined',
196
- 'operators_subtract',
197
- 'operators_subtract_outlined',
198
- 'pinned',
199
- 'pin_outlined',
200
- 'placeholder',
201
- 'placeholder_outlined',
202
- 'primary_cluster',
203
- 'primary_cluster_outlined',
204
- 'product_analyst',
205
- 'product_analyst_outlined',
206
- 'product_appcenter',
207
- 'product_appcenter_outlined',
208
- 'product_console',
209
- 'product_console_outlined',
210
- 'product_cx',
211
- 'product_cx_outlined',
212
- 'product_editor',
213
- 'product_editor_outlined',
214
- 'product_jupyterhub',
215
- 'product_jupyterhub_outlined',
216
- 'product_modelops',
217
- 'product_modelops_outlined',
218
- 'product_outbound_campaign_manager',
219
- 'product_outbound_campaign_manager_outlined',
220
- 'product_querygrid',
221
- 'product_querygrid_outlined',
222
- 'product_streams',
223
- 'product_streams_outlined',
224
- 'product_vantage',
225
- 'product_vantage_outlined',
226
- 'product_viewpoint',
227
- 'product_viewpoint_outlined',
228
- 'professional_services',
229
- 'professional_services_outlined',
230
- 'report',
231
- 'report_outlined',
232
- 'resize_northeast',
233
- 'resize_northeast_outlined',
234
- 'resize_northwest',
235
- 'resize_northwest_outlined',
236
- 'resize_southeast',
237
- 'resize_southeast_outlined',
238
- 'resize_southwest',
239
- 'resize_southwest_outlined',
240
- 'row',
241
- 'row_outlined',
242
- 'rules',
243
- 'rules_outlined',
244
- 'rules_ondark',
245
- 'rules_insert',
246
- 'rules_insert_outlined',
247
- 'rules_insert_ondark',
248
- 'rules_select',
249
- 'rules_select_outlined',
250
- 'rules_select_ondark',
251
- 'sankey',
252
- 'sankey_outlined',
253
- 'script',
254
- 'script_outlined',
255
- 'script_ondark',
256
- 'script_macro',
257
- 'script_macro_ondark',
258
- 'script_management',
259
- 'script_management_outlined',
260
- 'script_sql',
261
- 'script_sql_outlined',
262
- 'script_sql_ondark',
263
- 'script_stored_procedure',
264
- 'script_stored_procedure_outlined',
265
- 'script_stored_procedure_ondark',
266
- 'segmentation',
267
- 'segmentation_outlined',
268
- 'server',
269
- 'server_outlined',
270
- 'server_changed',
271
- 'server_changed_outlined',
272
- 'server_edit',
273
- 'server_edit_outlined',
274
- 'server_foreign',
275
- 'server_foreign_outlined',
276
- 'server_lab',
277
- 'server_lab_outlined',
278
- 'server_search',
279
- 'server_search_outlined',
280
- 'server_synced',
281
- 'server_synced_outlined',
282
- 'server_workspace',
283
- 'server_workspace_outlined',
284
- 'sftp',
285
- 'sftp_outlined',
286
- 'sftp_ondark',
287
- 'slack',
288
- 'state_cancelled',
289
- 'state_cancelled_outlined',
290
- 'state_caution',
291
- 'state_caution_outlined',
292
- 'state_changed',
293
- 'state_changed_outlined',
294
- 'state_negative',
295
- 'state_negative_outlined',
296
- 'state_paused',
297
- 'state_paused_outlined',
298
- 'state_positive',
299
- 'state_positive_outlined',
300
- 'table',
301
- 'table_outlined',
302
- 'table_changed',
303
- 'table_changed_outlined',
304
- 'table_edit',
305
- 'table_edit_outlined',
306
- 'table_foreign',
307
- 'table_foreign_outlined',
308
- 'table_lab',
309
- 'table_lab_outlined',
310
- 'table_search',
311
- 'table_search_outlined',
312
- 'table_synced',
313
- 'table_synced_outlined',
314
- 'teradata',
315
- 'teradata_outlined',
316
- 'teradata_nocircle',
317
- 'teradata_nobackground',
318
- 'teradata_nobackground_outlined',
319
- 'text_analysis',
320
- 'text_analysis_outlined',
321
- 'undock',
322
- 'undock_outlined',
323
- 'user_defined_function',
324
- 'user_defined_function_outlined',
325
- 'variable',
326
- 'variable_outlined',
327
- 'variable_ondark',
328
- 'view_sankey',
329
- 'wand',
330
- 'wand_outlined',
331
- 'workflow',
332
- 'workflow_outlined',
333
- ];
334
-
335
23
  const _c0 = ["markdownWrapper"];
336
24
  const _c1 = () => ({});
337
25
  const _forTrack0 = ($index, $item) => $item.id ?? $index;
@@ -766,8 +454,9 @@ class TdMarkdownNavigatorComponent {
766
454
  return icon.split(';')[0];
767
455
  }
768
456
  isCovalentIcon(item) {
769
- const icon = this.getIcon(item);
770
- return COV_ICON_LIST.includes(icon);
457
+ if (!item?.icon)
458
+ return false;
459
+ return item?.icon.includes(';covalent');
771
460
  }
772
461
  handleChildrenUrlError(error) {
773
462
  this.childrenUrlError = error.message;
@@ -928,7 +617,7 @@ class TdMarkdownNavigatorComponent {
928
617
  type: HostListener,
929
618
  args: ['click', ['$event']]
930
619
  }] }); })();
931
- (() => { (typeof ngDevMode === "undefined" || ngDevMode) && i0.ɵsetClassDebugInfo(TdMarkdownNavigatorComponent, { className: "TdMarkdownNavigatorComponent", filePath: "markdown-navigator.component.ts", lineNumber: 96 }); })();
620
+ (() => { (typeof ngDevMode === "undefined" || ngDevMode) && i0.ɵsetClassDebugInfo(TdMarkdownNavigatorComponent, { className: "TdMarkdownNavigatorComponent", filePath: "markdown-navigator.component.ts", lineNumber: 95 }); })();
932
621
  function getTitleFromUrl(url) {
933
622
  if (url) {
934
623
  const temp = new URL(url);