@workxero/design-js
v1.0.6
Published
WorkXero Design System is a component library designed to help developers create the best experience for software or services distributed.
Downloads
16
Maintainers
workxeroReadme
WorkXero Design System - Components JS
WorkXero Design System is a component library designed to help developers create the best experience for software or services distributed by WorkXero Platforms. Visit the WorkXero Design System to learn more.
Using the WorkXero Design System
Installation
Run the following command using npm:
npm install @workxero/design-jsIf you prefer Yarn, use the following command instead:
yarn add @workxero/design-jsUsage
After adding the @workxero/design-js package to your project, the following page setup is recommended
(assuming a web server is running).
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
<title>WorkXero Design System</title>
<script src="PATH/TO/PACKAGE/@workxero/design-js/index.js"></script>
</head>
<body>
<script type="text/javascript">
workXeroDesignSystem.load();
</script>
<wx-button>Some label</wx-button>
</body>
</html>Methodology
Our goal is to provide easy-to-use and well-documented components so that developers don’t need to worry about the implementation but can focus on easily creating qualitative and consistent digital WorkXero experiences. We ensure that our components are made for everyone and meet latest quality standards of usability, accessibility, performance and compatibility. In some points the components are built restrictive to define consistent standards for diverse WorkXero applications but ensure enough flexibility to meet different context requirements.
License
- See Custom License within npm package