@hyperionx/xds-component-library

Getting Started

Quick Start (Vue CLI)

Assuming we're starting with a new Vue CLI project:

Vue CLI v3.7.0
? Please pick a preset: Manually select features
? Check the features needed for your project: Babel, CSS Pre-processors
? Pick a CSS pre-processor (PostCSS, Autoprefixer and CSS Modules are supported by default): Sass/SCSS (with node-
sass)
? Where do you prefer placing config for Babel, PostCSS, ESLint, etc.? In package.json
? Save this as a preset for future projects? No

Using Yarn

$ yarn add @hyperionx/xds-component-library

Or npm

$ npm install @hyperionx/xds-component-library

In src/main.js add the following to include the components.

import XDSComponents from '@hyperionx/xds-component-library/src/index';
Vue.use(XDSComponents);

Replace the contents of src/components/HelloWorld.vue with the following

<template>
  <div class="sample">
    <h1>Example use of @hyperionx/xds-component-library</h1>
    <x-text-input label="Who are you?" v-model="yourName" placeholder="your name" />
    <x-btn @click="onClick">Hello {{yourName}}</x-btn>
    <x-modal :visible="visible" @modal-hidden="modalClosed">
      <template slot="title">Welcome to @hyperionx/xds-component-library {{yourName}}</template>
      <template slot="content">
        <p>
          Lorem ipsum dolor sit amet, consectetur adipisicing elit, seed do eiusmod tempor incididunt ut labore et
          dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
          commodo consequat.
        </p>
      </template>
    </x-modal>
  </div>
</template>

<script>
  export default {
    name: 'HelloWorld',
    data() {
      return {
        yourName: '',
        visible: false,
      };
    },
    methods: {
      onClick() {
        this.visible = true;
      },
      modalClosed() {
        this.visible = false;
      },
    },
  };
</script>

<style>
  .sample {
    display: flex;
    flex-direction: column;
    justify-content: center;
    align-items: center;
    max-width: 600px;
    margin: 5% auto;
  }

  .x-text-input {
    margin: 30px 0;
  }
</style>

That's it! Now start the server and start building.

Using Yarn

$ yarn serve

Or npm

$ npm serve

Longer start

Install

Run the following command using npm:

npm install @hyperionx/xds-component-library

If you prefer Yarn, use the following command instead:

yarn add @hyperionx/xds-component-library

NOTE: current-script-polyfill is required for older browsers (e.g. IE11)

Using the component library

In your main js file (where you include Vue):

import XDSComponents from '@hyperionx/xds-component-library';
Vue.use(XDSComponents);

The above lines will register all the core components. You can register only the components you need if you prefer:

Vue.use(XDSComponents, ['XBtn', 'XTag']);

Using the components directly or individually

You can import the component source either for all core components or for the individual components you need.

To import all the core components:

import XDSComponents from '@hyperionx/xds-component-library/src/index';
Vue.use(XDSComponents);

To import individual components:

<script>
...
import { XBtn } from '@hyperionx/xds-component-library';
...
components: {
  XBtn,
},
...
</script>

Alternataively from source:

<script>
...
import { XBtn } from '@hyperionx/xds-component-library/src';
...
components: {
  XBtn,
},
...
</script>

or

<script>
...
import { XBtn } from '@hyperionx/xds-component-library/src/components/x-btn';
...
components: {
  XBtn,
},
...
</script>

or

<script>
...
import XBtn from '@hyperionx/xds-component-library/src/components/x-btn/x-btn';
...
components: {
  XBtn,
},
...
</script>

Note: to import the component source you will need to ensure that Babel can process the source. We recommend the Babel preset @vue/app. If @hyperionx/xds-component-library is installed as a dependency in a node_modules folder or similar, you may need to enable Babel to process the source files, for example with the following lines, or similar, inside the webpack.config.js file:

{
  test: /\.js$/,
  loader: 'babel-loader',
  include: [path.resolve(__dirname, 'node_modules/@hyperionx/xds-component-library'), path.resolve(__dirname, 'src')]
}
```h