0.4.1 • Published 3 years ago

ui-component-set v0.4.1

Weekly downloads
54
License
-
Repository
gitlab
Last release
3 years ago

UI-Component-Set

WARNING: this is a very early alpha version with limited components. More components will be added in the future.

Description

UI-Component-Set contains a set of Vue.js components written in Typescript, as well as a custom SCSS styling set of rules.

Table of Contents

Installation

npm install ui-components

Prepare 'tsconfig.json'

Add "ui-component-set" to the "types" property. This will make Typescript UI-Component-Set type definitions, which is necessary for Vue.js components on this module to work properly.

Usage

  • SCSS styling can be imported using one of the following sintaxes

    import 'ui-component-set/style/ui-components.scss';
    require('ui-component-set/style/ui-components.scss');

NOTE: Vue components are written on Typescript, so they should be imported into a Vue.js project which is also written on that language. Vue.js components on this package can be imported by using any of the following sintaxes: 1. ### Import all components and then accesing specific components:

```typescript
import UIComponentSet from 'ui-component-set';
const <COMPONENT_NAME_1> = UIComponentSet.<COMPONENT_NAME_1>;
const <COMPONENT_NAME_2> = UIComponentSet.<COMPONENT_NAME_2>;
...
```
  1. Import every specified component at once:

      import { <COMPONENT_NAME_1>, <COMPONENT_NAME_2>, ... } from 'ui-component-set';
  1. Import single component at a time:

    import <COMPONENT_NAME_1> from 'ui-component-set/<component-name_1>';
    import <COMPONENT_NAME_2> from 'ui-component-set/<component-name_2>';
    ...

Available components

Segmented Progress Bar (segmented-progress-bar)

PropertyTypeDefaultDescription
progressNumber0Progress expressed as a number between 0 and 1.
showBorderBooleanfalseDisplay border surrounding the progress bar.
borderColorString#000Progress bar border color. Has no effect if 'showBorder' is false or not specified'
segmentColorString#000Set color for progress bar segments.
enableBlinkingBooleanfalseIf true, the segment next to the last active one will be blinking.
segmentsNumber10Number of segments used to display the progress. Has no effect if 'fixedSegmentWidth' is specified.
segmentOffsetNumber2.5Define margin between segments.
heightString50pxDefine height of the progress bar. accepted.
widthString100%Define width of the progress bar.
borderRadiusString2.5pxDefine 'border-radius' property for progress bar's border. Has no effect if 'showBorder' is false or not specified.
segmentBorderRadiusString2.5pxDefine 'border-radius' property for the segments.
fixedSegmentWidthNumberundefinedDefine width for the segments. If this property is specified, 'segments' will have no effect, as the number of segments will be calculated according to the 'fixedSegmentWidth' and 'segmentOffset' properties.
0.4.1

3 years ago

0.4.0

3 years ago

0.3.2-0

4 years ago

0.3.1-0

4 years ago

0.3.0-0

4 years ago

0.2.0-0

4 years ago

0.1.0-0

4 years ago

0.0.9-0

4 years ago

0.0.8-0

4 years ago

0.0.7-0

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago