@moxiworks/mds-alpha

Moxi Design System

The Moxi Design System is a framework utilizing TailwindCSS and StencilJS to provide a CSS foundational framework combined with a library of universal Javascript components to use in any project with any framework you desire.

The goal is to create this framework to the spec of our design team and committing to the continued growth of this system moving forward.

Development

The project uses Vuepress as a means to write documentation as you develop. When the system is built, Vuepress is compiled to the docs directory to be accessed via Github pages. This project also uses yarn over npm.

Installing Yarn

npm install yarn -g

Cloning For Local Development

• Fork and then clone the project locally.
• Inside the cloned direcrory run yarn install.
• After the dependencies are installed run yarn dev to start the development Vuepress server.

You can now access the site at http://localhost:8080.

Formatting and linting

The project uses prettier to standardize code style. If you have a prettier plugin installed in your editor, then files may be formatted automatically on save. Otherwise, staged files will be formatted during a pre-commit hook (via husky and lint-staged). See the .prettierrc file for rules.

JavaScript and TypeScript files will also be linted prior to being committed. The commit will fail if there are any warnings or errors per our .eslintrc.js ruleset, which is based on eslint:recommended and @typescript-eslint/recommended.

Vuepress Documentation Only Creation and Editing

This has been updated to where you can simply run yarn:dev to update documentation without the worry of unintended dynamic file c

Where Things Live

Vuepress

The development site is located under the vuepress directory. To learn more about Vuepress and it's paradigms, please read the documentation here.

The basics are very straight forward. The site is powered by Markdown files. Add and edit folders and .md files as needed for documentation and development.

You can develop the component in Vuepress then write the documentation around it when ready.

StencilJS Components

All of the StencilJS components are located in the src directory. There is a generator to stub a new component: yarn generate mx-{name of component}. All of the components are prefixed with mx-. For example, the input component is called mx-input which is essentially the tag name <mx-input />.

You can read more about Stencil, it's lifecycle methods, property handling, etc at https://stenciljs.com/docs/introduction.

TailwindCSS

The TailwindCSS code is located under src/tailwind. The configuration file is located in the root of the directory as tailwind.config.js.

You can read more about TailwindCSS here.

IMPORTANT :rotating_light: :rotating_light: :rotating_light:

We are not using the Shadow DOM for the Stencil components and are not using the CSS paradigm they provide. The reason is that the CSS for this project needs to also support Ruby based view components. You can read more about them here: https://viewcomponent.org/.

There's no reason to write and maintain this CSS in two places so the TailwindCSS implementation will be the source of truth for our component styling.

Under src/tailwind you'll see directories like mx-input and mx-button. Those SASS directories and files are included in the styles.scss file. SCSS is transpiled to CSS immediately thanks to PostCSS.

Using In A Project

From your project run yarn add @moxiworks/mds or npm install @moxiworks/mds depending on your package manager.

At your entry point add the following code:

import { applyPolyfills, defineCustomElements } from '@moxiworks/mds/loader';

// Bind the custom elements to the window object
applyPolyfills().then(() => {
  defineCustomElements();
});

StencilJS provides a loader which dynamically "tree-shakes" the code as needed. So, for example, the bundle for the mx-input won't be included in your bundle until you've written code in one of your views like:

<mx-input label="Placeholder & Left Icon" left-icon="ph-apple-logo" />

Framework Integrations

StencilJS has a bunch of documentation around integrating these types of components into most popular frameworks - including vanilla Javascript. You can read more about that here: https://stenciljs.com/docs/overview