@walkme/wm-ui

UI components for WalkMe apps

Usage no npm install needed!

<script type="module">
  import walkmeWmUi from 'https://cdn.skypack.dev/@walkme/wm-ui';
</script>

README

wm-ui-components

UI Component Library for WalkMe applications.

Usage

  1. Install this library and its peer-dependencies:
npm i @walkme/wm-ui @material-ui/core @material-ui/lab react react-dom react-smooth-dnd
  1. Wrap your root app component with the provided WMStylesProvider.

For example:

import { WMStylesProvider } from '@walkme/wm-ui';

// Some code...

    <WMStylesProvider>
        <App />
    </WMStylesProvider>

// More code...
  1. To use a component, just import it. It's usually something like:
import { WMSomething } from '@walkme/wm-ui';

Contributing

Want to contribute? Great!

Please follow the next steps, after you fork/clone your own copy of Walkme-UI.

  1. Install dependencies:
npm install
  1. View all components and documentation available on Storybook:
npm start

Or, go to our live Storybook site.