Wijmo Ribbon (React)

Wijmo 5 does not include a Ribbon control, but you can create ribbons easily using the TabPanel control and the controls in Wijmo's input module.

This example shows how you can build a simple text editor with a custom ribbon.

The ribbon element is a TabPanel. The tab pages contain groups of controls arranged in rows and columns. Controls in the groups use Material Icons, and have tooltips created automatically based on the aria-label attribute assigned to each control.

You can toggle the ribbon content visibility by double-clicking the empty area beside the tab headers.

Learn about Wijmo | TabPanel API Reference

This example uses React.

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import ReactDOM from 'react-dom/client'; import { findDOMNode } from 'react-dom'; import React, { useEffect, useRef, useState } from 'react'; import useEvent from 'react-use-event-hook'; import { TabPanel, Tab } from '@mescius/wijmo.react.nav'; import * as wijmo from '@mescius/wijmo'; import { ComboBox, ColorPicker } from '@mescius/wijmo.react.input'; import './app.css'; function App() { const [content, setContent] = useState(` <b>Lorem Ipsum</b> is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. `); const ribbon = useRef(null); const ribbonEl = useRef(null); const editor = useRef(null); const editorEl = useRef(null); const clrPicker = useRef(null); const bkgPicker = useRef(null); const selection = useRef(null); useEffect(() => { var _a; if (localStorage.editorContent) { setContent(localStorage.editorContent); } if (ribbon) { ribbonEl.current = findDOMNode(ribbon.current); if (ribbonEl.current) { // handle button clicks ribbonEl.current.addEventListener('click', handleButtonClick); // hide/show buttons (_a = ribbonEl.current.querySelector('.wj-tabheaders')) === null || _a === void 0 ? void 0 : _a.addEventListener('dblclick', e => { if (!wijmo.hasClass(e.target, 'wj-tabheader')) { if (ribbonEl.current) { wijmo.toggleClass(ribbonEl.current, 'hide-content'); } } }); // show tooltips const tt = new wijmo.Tooltip(); const els = ribbonEl.current.querySelectorAll('[aria-label]'); for (let i = 0; i < els.length; i++) { tt.setTooltip(els[i], els[i].getAttribute('aria-label')); } } } editorEl.current = editor.current; if (editorEl.current) { // save/restore editor selection on focus changes editorEl.current.addEventListener('keyup', () => selection.current = saveSelection()); editorEl.current.addEventListener('mouseup', () => selection.current = saveSelection()); editorEl.current.addEventListener('focus', () => restoreSelection(selection.current)); } }, []); const handleButtonClick = (e) => { var _a; switch (e.target.id) { // format group case 'save': localStorage.editorContent = (_a = editorEl.current) === null || _a === void 0 ? void 0 : _a.innerHTML; alert('Document Saved to Local Storage.'); break; case 'undo': case 'redo': case 'preview': case 'removeFormat': case 'cut': case 'copy': case 'paste': case 'selectAll': execCommand(e.target.id); break; // font group case 'bold': case 'italic': case 'underline': case 'strikethrough': case 'subscript': case 'superscript': execCommand(e.target.id); break; case 'click-me': alert('Wijmo Ribbon Sample'); } }; const saveSelection = () => { const sel = window.getSelection(); return sel && sel.rangeCount ? sel.getRangeAt(0) : null; }; const restoreSelection = useEvent((range) => { if (range) { const sel = window.getSelection(); if (sel) { sel.removeAllRanges(); sel.addRange(range); } } }); const showBkgPicker = (e) => { showPicker(findDOMNode(bkgPicker.current), e); }; const showClrPicker = (e) => { showPicker(findDOMNode(clrPicker.current), e); }; const showPicker = (pickerComponent, e) => { wijmo.showPopup(pickerComponent, e.target, false, true, false); pickerComponent.focus(); }; const hideColorPicker = useEvent((colorPicker) => { wijmo.hidePopup(colorPicker.hostElement); }); const bkgChanged = useEvent((colorPicker) => { execCommand('backColor', colorPicker.value); hideColorPicker(colorPicker); }); const clrChanged = useEvent((colorPicker) => { execCommand('foreColor', colorPicker.value); hideColorPicker(colorPicker); }); const fontChanged = useEvent((comboBox) => { execCommand('fontName', comboBox.text); }); const sizeChanged = useEvent((comboBox) => { execCommand('fontSize', comboBox.selectedIndex + 1); }); const execCommand = (cmd, parm) => { var _a; (_a = editorEl.current) === null || _a === void 0 ? void 0 : _a.focus(); document.execCommand(cmd, false, parm); }; return (<div> <TabPanel ref={ribbon}> <Tab> <a>Format</a> <div> <div className="wj-group"> <div className="wj-content"> <div className="wj-column"> <button id="save" className="wj-btn wj-btn-large"> <i className="material-icons">save</i> <br /> Save </button> </div> <div className="wj-column"> <div className="wj-row"> <button id="undo" className="wj-btn" aria-label="Undo"> <i className="material-icons">undo</i> </button> <button id="redo" className="wj-btn" aria-label="Redo"> <i className="material-icons">redo</i> </button> <button id="preview" className="wj-btn" aria-label="Preview"> <i className="material-icons">pageview</i> </button> <button id="removeFormat" className="wj-btn" aria-label="Remove Format"> <i className="material-icons">format_clear</i> </button> </div> <div className="wj-row"> <button id="cut" className="wj-btn" aria-label="Cut"> <i className="material-icons">&#x2702;</i> </button> <button id="copy" className="wj-btn" aria-label="Copy"> <i className="material-icons">&#xE14D;</i> </button> <button id="paste" className="wj-btn" aria-label="Paste"> <i className="material-icons">&#xE85D;</i> </button> <button id="selectAll" className="wj-btn" aria-label="Select All"> <i className="material-icons">select_all</i> </button> </div> </div> </div> <div className="wj-header">Actions</div> </div> <div className="wj-group"> <div className="wj-content"> <div className="wj-row"> <ComboBox id="fontFace" aria-label="Font Face" itemsSource={['Arial', 'Courier New', 'Garamond', 'Tahoma', 'Times', 'Verdana', 'WingDings']} textChanged={fontChanged}/> <ComboBox id="fontSize" aria-label="Font Size" itemsSource={['Very Small', 'Smaller', 'Small', 'Medium', 'Large', 'Larger', 'Very Large']} selectedIndex={3} textChanged={sizeChanged}/> <ColorPicker ref={bkgPicker} style={{ display: 'none' }} valueChanged={bkgChanged} lostFocus={hideColorPicker}/> <button id="background" className="wj-btn" aria-label="Background Color" onClick={showBkgPicker}> <i className="material-icons">format_color_fill</i> </button> <ColorPicker ref={clrPicker} style={{ display: 'none' }} valueChanged={clrChanged} lostFocus={hideColorPicker}/> <button id="color" className="wj-btn" aria-label="Text Color" onClick={showClrPicker}> <i className="material-icons">format_color_text</i> </button> </div> <div className="wj-row"> <button id="bold" className="wj-btn" aria-label="Bold"> <i className="material-icons">format_bold</i> </button> <button id="italic" className="wj-btn" aria-label="Italic"> <i className="material-icons">format_italic</i> </button> <button id="underline" className="wj-btn" aria-label="Underline"> <i className="material-icons">format_underline</i> </button> <button id="strikethrough" className="wj-btn" aria-label="Strikethrough"> <i className="material-icons">format_strikethrough</i> </button> <button id="subscript" className="wj-btn" aria-label="Subscript"> <i className="material-icons">vertical_align_bottom</i> </button> <button id="superscript" className="wj-btn" aria-label="Superscript"> <i className="material-icons">vertical_align_top</i> </button> </div> </div> <div className="wj-header">Font</div> </div> </div> </Tab> <Tab> <a>Custom Tab</a> <div> <div className="wj-group"> <div className="wj-content"> <div className="wj-column"> <button id="click-me" className="wj-btn wj-btn-large"> Click Me </button> </div> </div> <div className="wj-header">Custom Group</div> </div> </div> </Tab> </TabPanel> <div className='editor' ref={editor} contentEditable dangerouslySetInnerHTML={{ __html: content }}/> </div>); } const container = document.getElementById('app'); if (container) { const root = ReactDOM.createRoot(container); root.render(<App />); }
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MESCIUS Wijmo Wijmo TabPanel Ribbon</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- SystemJS --> <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.40/system.src.js" integrity="sha512-G6mEj6h18+m3MvzdviSDfPle/TfH0//cXcB33AKlNR/Rha0yQsKefDZKRTkIZos97HEGq2JMV1RT5ybMoQ3WsQ==" crossorigin="anonymous"></script> <script src="systemjs.config.js"></script> <script> System.import('./src/app'); </script> </head> <body> <div id="app"></div> </body> </html>
@import url('https://fonts.googleapis.com/icon?family=Material+Icons'); .wj-tabpane { white-space: nowrap; /* keep groups on a single line */ } .wj-group { display: inline-block; border-right: 1px solid #eee; padding: 3px 6px 0 3px; } .wj-group>.wj-header { text-align: center; background: transparent; font-weight: normal; font-size: 80%; margin-top: 6px; } .wj-group>.wj-content { border: none; height: 5.5em; overflow: visible; } .wj-group .wj-column { display: inline-block; vertical-align: top; } .wj-group .wj-row { margin-bottom: 2px; } .wj-control .wj-group .wj-content .wj-btn { font-weight: normal; padding: 5px 12px; } .wj-group .wj-content .wj-btn.wj-btn-large { padding: 2em 1.5em; } .wj-group .material-icons { font-size: 110%; padding-top: 2px; pointer-events: none; } .wj-group .wj-dropdown { width: 10em; border: none; background: #eee; } /* hide ribbon content */ .wj-tabpanel.hide-content .wj-tabpanes { height: 0; transition: height linear 400ms; } .editor { height: 300px; overflow: auto; padding: 12px; background: #ffe; border: 1px solid #ccc; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true, react: true }, meta: { '*.css': { loader: 'css' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { 'jszip': 'npm:jszip/dist/jszip.js', '@mescius/wijmo': 'npm:@mescius/wijmo/index.js', '@mescius/wijmo.input': 'npm:@mescius/wijmo.input/index.js', '@mescius/wijmo.styles': 'npm:@mescius/wijmo.styles', '@mescius/wijmo.cultures': 'npm:@mescius/wijmo.cultures', '@mescius/wijmo.chart': 'npm:@mescius/wijmo.chart/index.js', '@mescius/wijmo.chart.analytics': 'npm:@mescius/wijmo.chart.analytics/index.js', '@mescius/wijmo.chart.animation': 'npm:@mescius/wijmo.chart.animation/index.js', '@mescius/wijmo.chart.annotation': 'npm:@mescius/wijmo.chart.annotation/index.js', '@mescius/wijmo.chart.finance': 'npm:@mescius/wijmo.chart.finance/index.js', '@mescius/wijmo.chart.finance.analytics': 'npm:@mescius/wijmo.chart.finance.analytics/index.js', '@mescius/wijmo.chart.hierarchical': 'npm:@mescius/wijmo.chart.hierarchical/index.js', '@mescius/wijmo.chart.interaction': 'npm:@mescius/wijmo.chart.interaction/index.js', '@mescius/wijmo.chart.radar': 'npm:@mescius/wijmo.chart.radar/index.js', '@mescius/wijmo.chart.render': 'npm:@mescius/wijmo.chart.render/index.js', '@mescius/wijmo.chart.webgl': 'npm:@mescius/wijmo.chart.webgl/index.js', '@mescius/wijmo.chart.map': 'npm:@mescius/wijmo.chart.map/index.js', '@mescius/wijmo.gauge': 'npm:@mescius/wijmo.gauge/index.js', '@mescius/wijmo.grid': 'npm:@mescius/wijmo.grid/index.js', '@mescius/wijmo.grid.detail': 'npm:@mescius/wijmo.grid.detail/index.js', '@mescius/wijmo.grid.filter': 'npm:@mescius/wijmo.grid.filter/index.js', '@mescius/wijmo.grid.search': 'npm:@mescius/wijmo.grid.search/index.js', '@mescius/wijmo.grid.grouppanel': 'npm:@mescius/wijmo.grid.grouppanel/index.js', '@mescius/wijmo.grid.multirow': 'npm:@mescius/wijmo.grid.multirow/index.js', '@mescius/wijmo.grid.transposed': 'npm:@mescius/wijmo.grid.transposed/index.js', '@mescius/wijmo.grid.transposedmultirow': 'npm:@mescius/wijmo.grid.transposedmultirow/index.js', '@mescius/wijmo.grid.pdf': 'npm:@mescius/wijmo.grid.pdf/index.js', '@mescius/wijmo.grid.sheet': 'npm:@mescius/wijmo.grid.sheet/index.js', '@mescius/wijmo.grid.xlsx': 'npm:@mescius/wijmo.grid.xlsx/index.js', '@mescius/wijmo.grid.selector': 'npm:@mescius/wijmo.grid.selector/index.js', '@mescius/wijmo.grid.cellmaker': 'npm:@mescius/wijmo.grid.cellmaker/index.js', '@mescius/wijmo.grid.immutable': 'npm:@mescius/wijmo.grid.immutable/index.js', '@mescius/wijmo.touch': 'npm:@mescius/wijmo.touch/index.js', '@mescius/wijmo.cloud': 'npm:@mescius/wijmo.cloud/index.js', '@mescius/wijmo.nav': 'npm:@mescius/wijmo.nav/index.js', '@mescius/wijmo.odata': 'npm:@mescius/wijmo.odata/index.js', '@mescius/wijmo.olap': 'npm:@mescius/wijmo.olap/index.js', '@mescius/wijmo.rest': 'npm:@mescius/wijmo.rest/index.js', '@mescius/wijmo.pdf': 'npm:@mescius/wijmo.pdf/index.js', '@mescius/wijmo.pdf.security': 'npm:@mescius/wijmo.pdf.security/index.js', '@mescius/wijmo.viewer': 'npm:@mescius/wijmo.viewer/index.js', '@mescius/wijmo.xlsx': 'npm:@mescius/wijmo.xlsx/index.js', '@mescius/wijmo.undo': 'npm:@mescius/wijmo.undo/index.js', '@mescius/wijmo.interop.grid': 'npm:@mescius/wijmo.interop.grid/index.js', '@mescius/wijmo.barcode': 'npm:@mescius/wijmo.barcode/index.js', '@mescius/wijmo.barcode.common': 'npm:@mescius/wijmo.barcode.common/index.js', '@mescius/wijmo.barcode.composite': 'npm:@mescius/wijmo.barcode.composite/index.js', '@mescius/wijmo.barcode.specialized': 'npm:@mescius/wijmo.barcode.specialized/index.js', "@mescius/wijmo.react.chart.analytics": "npm:@mescius/wijmo.react.chart.analytics/index.js", "@mescius/wijmo.react.chart.animation": "npm:@mescius/wijmo.react.chart.animation/index.js", "@mescius/wijmo.react.chart.annotation": "npm:@mescius/wijmo.react.chart.annotation/index.js", "@mescius/wijmo.react.chart.finance.analytics": "npm:@mescius/wijmo.react.chart.finance.analytics/index.js", "@mescius/wijmo.react.chart.finance": "npm:@mescius/wijmo.react.chart.finance/index.js", "@mescius/wijmo.react.chart.hierarchical": "npm:@mescius/wijmo.react.chart.hierarchical/index.js", "@mescius/wijmo.react.chart.interaction": "npm:@mescius/wijmo.react.chart.interaction/index.js", "@mescius/wijmo.react.chart.radar": "npm:@mescius/wijmo.react.chart.radar/index.js", "@mescius/wijmo.react.chart": "npm:@mescius/wijmo.react.chart/index.js", "@mescius/wijmo.react.core": "npm:@mescius/wijmo.react.core/index.js", '@mescius/wijmo.react.chart.map': 'npm:@mescius/wijmo.react.chart.map/index.js', "@mescius/wijmo.react.gauge": "npm:@mescius/wijmo.react.gauge/index.js", "@mescius/wijmo.react.grid.detail": "npm:@mescius/wijmo.react.grid.detail/index.js", "@mescius/wijmo.react.grid.filter": "npm:@mescius/wijmo.react.grid.filter/index.js", "@mescius/wijmo.react.grid.grouppanel": "npm:@mescius/wijmo.react.grid.grouppanel/index.js", '@mescius/wijmo.react.grid.search': 'npm:@mescius/wijmo.react.grid.search/index.js', "@mescius/wijmo.react.grid.multirow": "npm:@mescius/wijmo.react.grid.multirow/index.js", "@mescius/wijmo.react.grid.sheet": "npm:@mescius/wijmo.react.grid.sheet/index.js", '@mescius/wijmo.react.grid.transposed': 'npm:@mescius/wijmo.react.grid.transposed/index.js', '@mescius/wijmo.react.grid.transposedmultirow': 'npm:@mescius/wijmo.react.grid.transposedmultirow/index.js', '@mescius/wijmo.react.grid.immutable': 'npm:@mescius/wijmo.react.grid.immutable/index.js', "@mescius/wijmo.react.grid": "npm:@mescius/wijmo.react.grid/index.js", "@mescius/wijmo.react.input": "npm:@mescius/wijmo.react.input/index.js", "@mescius/wijmo.react.olap": "npm:@mescius/wijmo.react.olap/index.js", "@mescius/wijmo.react.viewer": "npm:@mescius/wijmo.react.viewer/index.js", "@mescius/wijmo.react.nav": "npm:@mescius/wijmo.react.nav/index.js", "@mescius/wijmo.react.base": "npm:@mescius/wijmo.react.base/index.js", '@mescius/wijmo.react.barcode.common': 'npm:@mescius/wijmo.react.barcode.common/index.js', '@mescius/wijmo.react.barcode.composite': 'npm:@mescius/wijmo.react.barcode.composite/index.js', '@mescius/wijmo.react.barcode.specialized': 'npm:@mescius/wijmo.react.barcode.specialized/index.js', 'jszip': 'npm:jszip/dist/jszip.js', 'react': 'npm:react/umd/react.production.min.js', 'react-dom': 'npm:react-dom/umd/react-dom.production.min.js', 'react-dom/client': 'npm:react-dom/umd/react-dom.production.min.js', 'redux': 'npm:redux/dist/redux.min.js', 'react-redux': 'npm:react-redux/dist/react-redux.min.js', 'bootstrap.css': 'npm:bootstrap/dist/css/bootstrap.min.css', 'css': 'npm:systemjs-plugin-css/css.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js', "react-use-event-hook": "npm:react-use-event-hook/dist/esm/useEvent.js", }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'jsx' }, "node_modules": { defaultExtension: 'js' }, } }); })(this);