Spl-ui NPM | npm.io

Shippasless UI Package

Welcome to the Shippasless UI Package, a comprehensive library of Vue.js components designed for building cohesive, user-friendly interfaces across all Shippasless websites and platforms. Our package aims to streamline the development process, ensuring a consistent look and feel while offering flexibility and customization.

Features

Reusable Vue.js Components: A collection of ready-to-use Vue.js components tailored for Shippasless's digital ecosystem.
Customization and Theming: Easily customizable components to match your project's branding and aesthetics.
Accessibility and Responsiveness: Ensures that all components are accessible and responsive, providing an optimal user experience on any device.
Performance Optimized: Components are optimized for performance, ensuring fast loading times and smooth interactions.
Comprehensive Documentation: Detailed documentation for each component, including examples and configuration options.

Getting Started

Prerequisites

Node.js (version 12.x or later)
npm (version 6.x or later) or Yarn (version 1.22.x or later)
Vue.js (version 2.x or 3.x)

Installation

To install the Shippasless UI Package, run the following command in your project directory:

npm install spl-ui --save
# Or using Yarn
yarn add spl-ui

Usage

Import the Shippasless UI components into your Vue application:

import Vue from 'vue'
import { OutlinedButton } from 'spl-ui'
import 'spl-ui/dist/shippasless-ui.css'

Vue.use(ShippaslessUI)

Now you can use any of the components in your Vue templates:

<template>
  <OutlinedButton color="primary">Click me!</OutlinedButton>
</template>

Documentation

For detailed documentation on each component and API references, please visit our documentation site.

Contributing

We welcome contributions to the Shippasless UI Package! If you're interested in contributing, please read our contributing guidelines for more information on how to get started.