Smart.Ribbon - configuration and usage

Getting Started with Ribbon Web Component

Setup the Ribbon

Smart UI for Web Components is distributed as smart-webcomponents NPM package

1. Download and install the package.
   
   

   npm install smart-webcomponents

   
   
2. Once installed, import the Ribbon module in your application.
   
   

   <script type="module" src="node_modules/smart-webcomponents/source/modules/smart.ribbon.js"></script>

   
   
3. Adding CSS reference
   
   The smart.default.css CSS file should be referenced using following code.
   
   

   <link rel="stylesheet" type="text/css" href="node_modules/smart-webcomponents/source/styles/smart.default.css" />

   
   
4. Add the Ribbon tag to your Web Page
   
   

   <smart-ribbon id="ribbon"></smart-ribbon>

   
   
5. Create the Ribbon Component
   
   

   	<script type="module">
   		Smart('#ribbon', class {
   			get properties() {
   				return { 
   				  dataSource: [{
   						label: 'Home',
   						ribbonGroups: [{
   						  label: 'Clipboard',
   						  icon: 'content_paste material-icons',
   						  ribbonItems: [{
   							label: 'Paste',
   							icon: 'content_paste material-icons',
   							size: 'normal',
   							cssClass: 'flat',
   							type: 'button',
   							allowedSizes: ['normal']
   						  },
   						  {
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  label: 'Cut',
   							  icon: 'content_cut material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							},
   							{
   							  label: 'Copy',
   							  icon: 'content_copy material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall'
   							}
   							]
   						  }
   						  ]
   						},
   						{
   						  label: 'Font',
   						  icon: 'format_bold material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Font',
   								type: 'input',
   								settings: {
   								  dataSource: ['Arial', 'Arial Black', 'Calibri'],
   								  value: 'Arial',
   								  dropDownButtonPosition: 'right'
   								},
   								cssClass: 'font-family-input'
   							  },
   							  {
   								label: 'Font size',
   								type: 'input',
   								settings: {
   								  dataSource: [8, 9, 10, 11, 12, 14, 16, 18, 20, 22, 24, 28, 36, 48, 72],
   								  value: '11',
   								  dropDownButtonPosition: 'right'
   								},
   								cssClass: 'font-size-input'
   							  },
   							  ]
   							},
   							{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Bold',
   								icon: 'format_bold material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Italic',
   								icon: 'format_italic material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Underline',
   								icon: 'format_underlined material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: '',
   								tooltip: 'Font color',
   								itemTemplate: '',
   								settings: {
   								  value: '#000000',
   								  valueDisplayMode: 'colorBox',
   								  dropDownAppendTo: 'body',
   								},
   							  }
   							  ]
   							}
   							]
   						  }]
   						},
   						{
   						  label: 'Paragraph',
   						  icon: 'format_align_left material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Align left',
   								icon: 'format_align_left material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Align center',
   								icon: 'format_align_center material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Align right',
   								icon: 'format_align_right material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: 'Justify',
   								icon: 'format_align_justify material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  }
   							  ]
   							},
   							{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Numbered list',
   								icon: 'format_list_numbered material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Bulleted list',
   								icon: 'format_list_bulleted material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: 'Decrease indent',
   								icon: 'format_indent_decrease material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Increase indent',
   								icon: 'format_indent_increase material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  }
   							  ]
   							}
   							]
   						  },
   						  {
   							type: 'separator'
   						  },
   						  {
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  label: 'Wrap text',
   							  icon: 'wrap_text material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['iconOnly','verySmall']
   							},
   							{
   							  label: 'Sort Selection',
   							  icon: 'sort_by_alpha material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['iconOnly','verySmall']
   							}
   							]
   						  }
   						  ]
   						},
   						{
   						  label: 'Editing',
   						  icon: 'edit material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							wrapSize: 'verySmall',
   							ribbonItems: [{
   							  label: 'Find',
   							  icon: 'search material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'normal',
   							  allowedSizes: ['verySmall', 'normal']
   							},
   							{
   							  type: 'group',
   							  wrapSize: 'small',
   							  ribbonItems: [
   								{
   								  label: 'Replace',
   								  icon: 'find_replace material-icons',
   								  type: 'button',
   								  cssClass: 'flat',
   								  size: 'normal',
   								  allowedSizes: ['verySmall', 'small', 'normal']
   								},
   								{
   								  label: 'Select all',
   								  icon: 'select_all material-icons',
   								  type: 'button',
   								  cssClass: 'flat',
   								  size: 'normal',
   								  allowedSizes: ['verySmall', 'small', 'normal']
   								}
   							  ]
   							},
   							]
   						  }]
   						}
   						]
   					  },
   					  {
   						label: 'Insert',
   						ribbonGroups: [{
   						  label: 'Tables',
   						  icon: 'table_chart material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Insert table',
   								icon: 'table_chart material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert row above',
   								icon: 'keyboard_arrow_up material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert row below',
   								icon: 'keyboard_arrow_down material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert column left',
   								icon: 'keyboard_arrow_left material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert column right',
   								icon: 'keyboard_arrow_right material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: 'Delete row',
   								icon: 'delete_sweep material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Delete column',
   								icon: 'delete_sweep material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Delete table',
   								icon: 'delete_sweep material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  }
   							  ]
   							},
   							{
   							  label: 'Table styles',
   							  itemTemplate: '',
   							  settings: {
   								dataSource: ['Table style 1', 'Table style 2', 'Table style 3', 'Table style 4', 'Table style 5'],
   								selectedValues: ['Table style 1'],
   								dropDownAppendTo: 'body',
   							  },
   							  cssClass: 'table-styles-drop-down'
   							}
   							]
   						  }]
   						},
   						{
   						  label: 'Illustrations',
   						  icon: 'insert_photo material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  label: 'Pictures',
   							  icon: 'insert_photo material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['verySmall']
   							},
   							{
   							  label: 'Online pictures',
   							  icon: 'cloud_upload material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['verySmall']
   							},
   							{
   							  label: 'Shapes',
   							  icon: 'bubble_chart material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['verySmall']
   							},
   							]
   						  },
   						  {
   							type: 'separator'
   						  },
   						  {
   							type: 'group',
   							wrapSize: 'small',
   							ribbonItems: [
   							{
   							  label: 'Icons',
   							  icon: 'insert_emoticon material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'normal',
   							  allowedSizes: ['small','normal']
   							},
   							{
   							  label: '3D models',
   							  icon: 'aspect_ratio material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'normal',
   							  allowedSizes: ['small','normal']
   							}]
   						  }
   						  ]
   						}
   						]
   					  },
   					  {
   						label: 'View',
   						ribbonGroups: [{
   						  label: 'Show',
   						  icon: 'visibility material-icons',
   						  wrapSize: 'small',
   						  ribbonItems: [{
   							label: 'Gridlines',
   							icon: 'grid_on material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  },
   						  {
   							label: 'Headings',
   							icon: 'view_headline material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  }
   						  ]
   						},
   						{
   						  label: 'Zoom',
   						  icon: 'zoom_out_map material-icons',
   						  wrapSize: 'small',
   						  ribbonItems: [{
   							label: 'Zoom to page',
   							icon: 'pageview material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  },
   						  {
   							label: 'Zoom to selection',
   							icon: 'zoom_out_map material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  },
   						  ]
   						}
   						]
   					  },
   					  {
   						label: 'Help',
   						wrapSize: 'small',
   						ribbonGroups: [{
   						  label: 'Help',
   						  icon: 'help_outline material-icons',
   						  ribbonItems: [{
   							label: 'Help',
   							icon: 'help_outline material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['verySmall','small','normal']
   						  },
   						  {
   							label: 'About',
   							icon: 'info_outline material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['verySmall','small','normal']
   						  }
   						  ]
   						}]
   					  }
   					  ],
   					  fileMenu: {
   						type: 'dropDown',
   						items: [{
   						  label: 'New',
   						  shortcut: 'Ctrl+N'
   						},
   						{
   						  label: 'Open',
   						  shortcut: 'Ctrl+0'
   						},
   						{
   						  label: 'Open Containing Folder',
   						  items: [{
   							label: 'Explorer'
   						  },
   						  {
   							label: 'cmd'
   						  }
   						  ]
   						},
   						{
   						  label: 'Save',
   						  shortcut: 'Ctrl+S',
   						  disabled: true,
   						  separator: true
   						},
   						{
   						  label: 'Exit',
   						  shortcut: 'Alt+F4'
   						}
   						]
   					  }
   					}
   				  }
   				}
   			}
   		});
   	</script>	   
   		

   
   Another option is to create the Ribbon is by using the traditional Javascript way:
   

   	const ribbon = document.createElement('smart-ribbon');
   
   	ribbon.disabled = true;
   	document.body.appendChild(ribbon);
   		

   
   Smart framework provides a way to dynamically create a web component on demand from a DIV tag which is used as a host. The following imports the web component's module and creates it on demand, when the document is ready. The #ribbon is the ID of a DIV tag.
   
   

   	import "../../source/modules/smart.ribbon.js";
   
   	document.readyState === 'complete' ? init() : window.onload = init;
   
   	function init() { 
   		const ribbon = new Smart.Ribbon('#ribbon', { 
   				  dataSource: [{
   						label: 'Home',
   						ribbonGroups: [{
   						  label: 'Clipboard',
   						  icon: 'content_paste material-icons',
   						  ribbonItems: [{
   							label: 'Paste',
   							icon: 'content_paste material-icons',
   							size: 'normal',
   							cssClass: 'flat',
   							type: 'button',
   							allowedSizes: ['normal']
   						  },
   						  {
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  label: 'Cut',
   							  icon: 'content_cut material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							},
   							{
   							  label: 'Copy',
   							  icon: 'content_copy material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall'
   							}
   							]
   						  }
   						  ]
   						},
   						{
   						  label: 'Font',
   						  icon: 'format_bold material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Font',
   								type: 'input',
   								settings: {
   								  dataSource: ['Arial', 'Arial Black', 'Calibri'],
   								  value: 'Arial',
   								  dropDownButtonPosition: 'right'
   								},
   								cssClass: 'font-family-input'
   							  },
   							  {
   								label: 'Font size',
   								type: 'input',
   								settings: {
   								  dataSource: [8, 9, 10, 11, 12, 14, 16, 18, 20, 22, 24, 28, 36, 48, 72],
   								  value: '11',
   								  dropDownButtonPosition: 'right'
   								},
   								cssClass: 'font-size-input'
   							  },
   							  ]
   							},
   							{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Bold',
   								icon: 'format_bold material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Italic',
   								icon: 'format_italic material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Underline',
   								icon: 'format_underlined material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: '',
   								tooltip: 'Font color',
   								itemTemplate: '',
   								settings: {
   								  value: '#000000',
   								  valueDisplayMode: 'colorBox',
   								  dropDownAppendTo: 'body',
   								},
   							  }
   							  ]
   							}
   							]
   						  }]
   						},
   						{
   						  label: 'Paragraph',
   						  icon: 'format_align_left material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Align left',
   								icon: 'format_align_left material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Align center',
   								icon: 'format_align_center material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Align right',
   								icon: 'format_align_right material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: 'Justify',
   								icon: 'format_align_justify material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  }
   							  ]
   							},
   							{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Numbered list',
   								icon: 'format_list_numbered material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Bulleted list',
   								icon: 'format_list_bulleted material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: 'Decrease indent',
   								icon: 'format_indent_decrease material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Increase indent',
   								icon: 'format_indent_increase material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  }
   							  ]
   							}
   							]
   						  },
   						  {
   							type: 'separator'
   						  },
   						  {
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  label: 'Wrap text',
   							  icon: 'wrap_text material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['iconOnly','verySmall']
   							},
   							{
   							  label: 'Sort Selection',
   							  icon: 'sort_by_alpha material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['iconOnly','verySmall']
   							}
   							]
   						  }
   						  ]
   						},
   						{
   						  label: 'Editing',
   						  icon: 'edit material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							wrapSize: 'verySmall',
   							ribbonItems: [{
   							  label: 'Find',
   							  icon: 'search material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'normal',
   							  allowedSizes: ['verySmall', 'normal']
   							},
   							{
   							  type: 'group',
   							  wrapSize: 'small',
   							  ribbonItems: [
   								{
   								  label: 'Replace',
   								  icon: 'find_replace material-icons',
   								  type: 'button',
   								  cssClass: 'flat',
   								  size: 'normal',
   								  allowedSizes: ['verySmall', 'small', 'normal']
   								},
   								{
   								  label: 'Select all',
   								  icon: 'select_all material-icons',
   								  type: 'button',
   								  cssClass: 'flat',
   								  size: 'normal',
   								  allowedSizes: ['verySmall', 'small', 'normal']
   								}
   							  ]
   							},
   							]
   						  }]
   						}
   						]
   					  },
   					  {
   						label: 'Insert',
   						ribbonGroups: [{
   						  label: 'Tables',
   						  icon: 'table_chart material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  type: 'group',
   							  direction: 'horizontal',
   							  ribbonItems: [{
   								label: 'Insert table',
   								icon: 'table_chart material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert row above',
   								icon: 'keyboard_arrow_up material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert row below',
   								icon: 'keyboard_arrow_down material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert column left',
   								icon: 'keyboard_arrow_left material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Insert column right',
   								icon: 'keyboard_arrow_right material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								type: 'separator'
   							  },
   							  {
   								label: 'Delete row',
   								icon: 'delete_sweep material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Delete column',
   								icon: 'delete_sweep material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  },
   							  {
   								label: 'Delete table',
   								icon: 'delete_sweep material-icons',
   								type: 'button',
   								cssClass: 'flat',
   								size: 'iconOnly'
   							  }
   							  ]
   							},
   							{
   							  label: 'Table styles',
   							  itemTemplate: '',
   							  settings: {
   								dataSource: ['Table style 1', 'Table style 2', 'Table style 3', 'Table style 4', 'Table style 5'],
   								selectedValues: ['Table style 1'],
   								dropDownAppendTo: 'body',
   							  },
   							  cssClass: 'table-styles-drop-down'
   							}
   							]
   						  }]
   						},
   						{
   						  label: 'Illustrations',
   						  icon: 'insert_photo material-icons',
   						  ribbonItems: [{
   							type: 'group',
   							direction: 'vertical',
   							ribbonItems: [{
   							  label: 'Pictures',
   							  icon: 'insert_photo material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['verySmall']
   							},
   							{
   							  label: 'Online pictures',
   							  icon: 'cloud_upload material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['verySmall']
   							},
   							{
   							  label: 'Shapes',
   							  icon: 'bubble_chart material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'verySmall',
   							  allowedSizes: ['verySmall']
   							},
   							]
   						  },
   						  {
   							type: 'separator'
   						  },
   						  {
   							type: 'group',
   							wrapSize: 'small',
   							ribbonItems: [
   							{
   							  label: 'Icons',
   							  icon: 'insert_emoticon material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'normal',
   							  allowedSizes: ['small','normal']
   							},
   							{
   							  label: '3D models',
   							  icon: 'aspect_ratio material-icons',
   							  type: 'button',
   							  cssClass: 'flat',
   							  size: 'normal',
   							  allowedSizes: ['small','normal']
   							}]
   						  }
   						  ]
   						}
   						]
   					  },
   					  {
   						label: 'View',
   						ribbonGroups: [{
   						  label: 'Show',
   						  icon: 'visibility material-icons',
   						  wrapSize: 'small',
   						  ribbonItems: [{
   							label: 'Gridlines',
   							icon: 'grid_on material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  },
   						  {
   							label: 'Headings',
   							icon: 'view_headline material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  }
   						  ]
   						},
   						{
   						  label: 'Zoom',
   						  icon: 'zoom_out_map material-icons',
   						  wrapSize: 'small',
   						  ribbonItems: [{
   							label: 'Zoom to page',
   							icon: 'pageview material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  },
   						  {
   							label: 'Zoom to selection',
   							icon: 'zoom_out_map material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['small','normal']
   						  },
   						  ]
   						}
   						]
   					  },
   					  {
   						label: 'Help',
   						wrapSize: 'small',
   						ribbonGroups: [{
   						  label: 'Help',
   						  icon: 'help_outline material-icons',
   						  ribbonItems: [{
   							label: 'Help',
   							icon: 'help_outline material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['verySmall','small','normal']
   						  },
   						  {
   							label: 'About',
   							icon: 'info_outline material-icons',
   							type: 'button',
   							cssClass: 'flat',
   							size: 'normal',
   							allowedSizes: ['verySmall','small','normal']
   						  }
   						  ]
   						}]
   					  }
   					  ],
   					  fileMenu: {
   						type: 'dropDown',
   						items: [{
   						  label: 'New',
   						  shortcut: 'Ctrl+N'
   						},
   						{
   						  label: 'Open',
   						  shortcut: 'Ctrl+0'
   						},
   						{
   						  label: 'Open Containing Folder',
   						  items: [{
   							label: 'Explorer'
   						  },
   						  {
   							label: 'cmd'
   						  }
   						  ]
   						},
   						{
   						  label: 'Save',
   						  shortcut: 'Ctrl+S',
   						  disabled: true,
   						  separator: true
   						},
   						{
   						  label: 'Exit',
   						  shortcut: 'Alt+F4'
   						}
   						]
   					  }
   					}
   				  }
   				});
   	}
   	

   
   
6. Open the page in your web server.

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event

	const ribbon = document.createElement('smart-ribbon');
	

	document.body.appendChild(ribbon);
	

	ribbon.parentNode.removeChild(ribbon);
	

	ribbon.propertyName = propertyValue;
	

	const propertyValue = ribbon.propertyName;
	

	ribbon.methodName(argument1, argument2);
	

	const eventHandler = (event) => {
	   // your code here.
	};

	ribbon.addEventListener(eventName, eventHandler);
	

	ribbon.removeEventListener(eventName, eventHandler, true);
	

Using with Typescript

Smart Web Components package includes TypeScript definitions which enables strongly-typed access to the Smart UI Components and their configuration.

Inside the download package, the typescript directory contains .d.ts file for each web component and a smart.elements.d.ts typescript definitions file for all web components. Copy the typescript definitions file to your project and in your TypeScript file add a reference to smart.elements.d.ts

Overview

Smart.Ribbon element represents a custom element that allows you to organize your application's commands in a tabbed interface.

To initialize a jqxRibbon, the user has to include the following files to the head of the page:

• smart.default.css - the CSS file containing the styles for element
• smart.ribbon.js - the JS file containing the element definition

The following code adds jqxRibbon element to the page.

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/modules/snart.ribbon.js"></script>
</head>
<body>
 <smart-ribbon>
    <smart-ribbon-tab label="Home" selected>
        <smart-ribbon-group label="Clipboard" icon="content_paste material-icons">
            <smart-ribbon-item type="button" label="Paste" icon="content_paste material-icons" size="normal"
            css-class="flat" allowed-sizes="['normal']"></smart-ribbon-item>
            <smart-ribbon-group direction="vertical">
                <smart-ribbon-item type="button" label="Cut" icon="content_cut material-icons" size="verySmall"
                    css-class="flat"></smart-ribbon-item>
                <smart-ribbon-item type="button" label="Copy" icon="content_copy material-icons" size="verySmall"
                    css-class="flat"></smart-ribbon-item>
            </smart-ribbon-group>
        </smart-ribbon-group>
    </smart-ribbon-tab> 
    <smart-ribbon-tab label="Insert">
        <smart-ribbon-group label="Illustrations" icon="insert_photo material-icons">
            <smart-ribbon-group direction="vertical">
                <smart-ribbon-item type="button" label="Pictures" icon="insert_photo material-icons"
                    size="verySmall" css-class="flat" allowed-sizes="['verySmall']"></smart-ribbon-item>
                <smart-ribbon-item type="button" label="Online pictures" icon="cloud_upload material-icons"
                    size="verySmall" css-class="flat" allowed-sizes="['verySmall']"></smart-ribbon-item>
                <smart-ribbon-item type="button" label="Shapes" icon="bubble_chart material-icons"
                    size="verySmall" css-class="flat" allowed-sizes="['verySmall']"></smart-ribbon-item>
            </smart-ribbon-group>
            <smart-ribbon-item type="separator"></smart-ribbon-item>
            <smart-ribbon-group wrap-size="small">
                <smart-ribbon-item type="button" label="Icons" icon="insert_emoticon material-icons"
                    size="normal" css-class="flat" allowed-sizes="['small', 'normal']"></smart-ribbon-item>
                <smart-ribbon-item type="button" label="3D models" icon="aspect_ratio material-icons"
                    size="normal" css-class="flat" allowed-sizes="['small', 'normal']"></smart-ribbon-item>
            </smart-ribbon-group>
        </smart-ribbon-group>
    </smart-ribbon-tab>
 </smart-ribbon>
</body>
</html>

Demo

Structure

The structure of the the Ribbon consists of smart-ribbon-tab elements.
Each smart-ribbon-tab should contain a series of smart-ribbon-group elements.
The smart-ribbon-group can contain either nested smart-ribbon-group or smart-ribbon-item Elements.

By using nested smart-ribbon-group elements in combination with additional properties such as wrapSize and direction, you can create complex layouts of vertically or horizontally aligned items, which can shift and wrap as the Ribbon is being resized. Example:

<smart-ribbon-group label="Paragraph" icon="format_align_left material-icons" direction="horizontal">
    <smart-ribbon-group direction="vertical">
        <smart-ribbon-group direction="horizontal">
            <smart-ribbon-item type="button" label="Align left" icon="format_align_left material-icons"
                size="iconOnly" css-class="flat"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Align center"
                icon="format_align_center material-icons" size="iconOnly" css-class="flat"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Align right"
                icon="format_align_right material-icons" size="iconOnly" css-class="flat"></smart-ribbon-item>
            <smart-ribbon-item type="separator"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Justify" icon="format_align_justify material-icons"
                size="iconOnly" css-class="flat"></smart-ribbon-item>
        </smart-ribbon-group>
        <smart-ribbon-group direction="horizontal">
            <smart-ribbon-item type="button" label="Numbered list"
                icon="format_list_numbered material-icons" size="iconOnly" css-class="flat"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Bulleted list"
                icon="format_list_bulleted material-icons" size="iconOnly" css-class="flat"></smart-ribbon-item>
            <smart-ribbon-item type="separator"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Decrease indent"
                icon="format_indent_decrease material-icons" size="iconOnly" css-class="flat"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Increase indent"
                icon="format_indent_increase material-icons" size="iconOnly" css-class="flat"></smart-ribbon-item>
        </smart-ribbon-group>
    </smart-ribbon-group>
    <smart-ribbon-item type="separator"></smart-ribbon-item>
    <smart-ribbon-group direction="vertical">
        <smart-ribbon-item type="button" label="Wrap text" icon="wrap_text material-icons"
            size="verySmall" css-class="flat"></smart-ribbon-item>
        <smart-ribbon-item type="button" label="Sort Selection" icon="sort_by_alpha material-icons"
            size="verySmall" css-class="flat"></smart-ribbon-item>
    </smart-ribbon-group>
</smart-ribbon-group>
<smart-ribbon-group label="Editing" icon="edit material-icons">
    <smart-ribbon-group wrap-size="verySmall">
        <smart-ribbon-item type="button" label="Find" icon="search material-icons" size="normal"
            css-class="flat" allowed-sizes="['verySmall', 'normal']"></smart-ribbon-item>
        <smart-ribbon-group wrap-size="small">
            <smart-ribbon-item type="button" label="Replace" icon="find_replace material-icons"
                size="normal" css-class="flat" allowed-sizes="['verySmall', 'small', 'normal']"></smart-ribbon-item>
            <smart-ribbon-item type="button" label="Select all" icon="select_all material-icons"
                size="normal" css-class="flat" allowed-sizes="['verySmall', 'small', 'normal']"></smart-ribbon-item>
        </smart-ribbon-group>
    </smart-ribbon-group>
</smart-ribbon-group>

Ribbon Items

The Smart.Ribbon element includes multiple built-in interactable item types - 'button', 'toggleButton', 'dropDownButton', 'multiSplitButton', 'input', 'separator' and 'custom'

When set to custom, the item will be set according to the itemTemplate property - it accepts Function, HTMLElement, or an id of a HTMLElement.

The "onClick" and "onChange" callback functions allow you to easily capture the user's interaction with the item.
If the item is a Smart.Element, the settings option allows you to apply any property available to the element.

Example:

            <smart-ribbon-group label="Font" icon="format_bold material-icons">
                <smart-ribbon-group direction="vertical">
                    <smart-ribbon-group direction="horizontal">
                        <smart-ribbon-item label="Font" class="font-family-input">
                            <smart-input
                            data-source='["Arial","Arial Black","Calibri"]' selected-values="['Arial']" drop-down-button-position="right"
                            drop-down-append-to="body">
                            </smart-input>
                        </smart-ribbon-item>
                        <smart-ribbon-item label="Font size" class="font-size-input">
                            <smart-input
                                data-source='[8,9,10,11,12,14,16,18,20,22,24,28,36,48,72]' selected-values="['11']" drop-down-button-position="right"
                                drop-down-append-to="body">
                            </smart-input>
                        </smart-ribbon-item>
                    </smart-ribbon-group>
                    <smart-ribbon-group direction="horizontal">
                        <smart-ribbon-item type="toggleButton" label="Bold" icon="format_bold material-icons"
                            size="iconOnly" css-class="flat"></smart-ribbon-item>
                        <smart-ribbon-item type="toggleButton" label="Italic" icon="format_italic material-icons"
                            size="iconOnly" css-class="flat"></smart-ribbon-item>
                        <smart-ribbon-item type="toggleButton" label="Underline" icon="format_underlined material-icons"
                            size="iconOnly" css-class="flat"></smart-ribbon-item>
                        <smart-ribbon-item type="separator"></smart-ribbon-item>
                        <smart-ribbon-item tooltip="Font color" size="iconOnly">
                            <smart-color-picker
                                value="#000000" value-display-mode="colorBox" drop-down-append-to="body">
                            </smart-color-picker>
                        </smart-ribbon-item>
                    </smart-ribbon-group>
                </smart-ribbon-group>
            </smart-ribbon-group>

File Menu

The Smart.Ribbon element also supports a built-in File Menu button.
When clicked, it will open a drop down menu, containing the list of items set in the fileMenu.items property.

Example:

window.Smart('#ribbon', class {
    get properties() {
        return {
        fileMenu: {
            type: 'dropDown',
            items: [{
                label: 'New',
                shortcut: 'Ctrl+N'
            },
            {
                label: 'Open',
                shortcut: 'Ctrl+0'
            },
            {
                label: 'Open Containing Folder',
                items: [{
                    label: 'Explorer'
                },
                {
                    label: 'cmd'
                }]
            },
            {
                label: 'Save',
                shortcut: 'Ctrl+S',
                disabled: true,
                separator: true
            },
            {
                label: 'Exit',
                shortcut: 'Alt+F4'
            }]
        }
        }
    }
});

Collapsed State

By clicking on the arrow icon in the right-hand menu or by programatically calling the expand/collapse methods, the Smart.Ribbon will toggle between its expanded and collapsed state.

The Collapsed State represents a minified layout of the Ribbon, where all items are displayed on a singe strip:

Resize Behavior

The Smart.Ribbon element will automatically seek to avoid overflow of its inner elements.
The Ribbon will attempt to reduce its width by reducing the size of the smart-ribbon-items, according to the options set in the allowedSizes property of each items.

When the Smart.Ribbon is in Expanded State and all items have been reduced to their minimum size, the Ribbon will gradually organize the smart-ribbon-group elements in dropDown Buttons:

When the Smart.Ribbon is in Collapsed State and all items have been reduced to their minimum size, the Ribbon will gradually collect the right-most ribbon items and group them in a dropDown Menu:

Keyboard Support

User can navigate between the ribbon via arrow keys. Arrow Up and Arrow Left will move the selection to the left, Arrow Down and Arrow Right - to the right. Home moves the selection to the first tab, End to the last.