1.0.3 • Published 4 years ago

@nutrify/ngx-simple-spinner v1.0.3

Weekly downloads
4
License
MIT
Repository
github
Last release
4 years ago

Ngx Simple Spinner

Simple and lightweight, yet customizable spinner/number input module for Angular.

Demo
Netlify Status

This is a number input component for Angular, fully supporting template driven forms and form validation. It is completely customizable using SCSS/CSS. Additionally it features: displaying most common fractions (1/2, 1/3, 1/4, ...), setting decimal places, i18n and RTL (right-to-left). It replicates Google Chrome's behaviour regarding its base functionality.

Installation

Ngx Simple Spinner requires Angular 9 or above.

npm install @nutrify/ngx-simple-spinner --save

You might also need to install @angular/cdk:

npm install @angular/cdk --save

For styling import @nutrify/ngx-simple-spinner/scss/styles.scss or @nutrify/ngx-simple-spinner/css/styles.css

Usage

app.module.ts:

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { AppComponent } from './app.component';
import { SimpleSpinnerModule } from '@nutrify/ngx-simple-spinner';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    SimpleSpinnerModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

component.ts:

// ...

export class Component {
  value = 12.5;
}

component.html:

<!-- ... -->

<simple-spinner [(ngModel)]="value" min="1" max="100" smallStep="0.25" maxDecimalPlaces="2" fractions="true"></simple-spinner>

<!-- ... -->

Check out the source code for an example.

Spinner

Inputs
PropertyDefaultDescription
placeholderOptional placeholder string, which gets displayed when value == null
valueValue of the number input
minNumber.MIN_SAFE_INTEGERMinimum value (can be a float value)
maxNumber.MAX_SAFE_INTEGERMaximum value (can be a float value)
bigStep1Number by which the current value should be in-/decremented using the nav/keyboard (can be a float value)
smallStep0.25Number by which the current value should be in-/decremented if 'bigStep' can't be applied (can be a float value)
maxDecimalPlaces0Maximum amount of decimal places that should be allowed to enter (exceeding decimal places get trimmed)
fractionsfalseBoolean describing whether or not fractions should be rendered
i18nNumberstrueE.g. converts 0-9 to arabic digits, if arabic is the browser's default language
hoverBorderfalseBoolean describing whether or not the border should only render on hover
hoverNavtrueBoolean describing whether or not the navigation should only render on hover
dirOptional direction property describing the content's orientation. Can be: 'ltr' \| 'rtl' \| 'auto'
Directives
PropertyDescription
disabledSets the disabled attribute
requiredSets the required attribute

Styling

You can use SCSS or CSS for styling.

Just import the stylesheet and apply changes to it.

The SCSS stylesheet is recommended since it exports more variables.

If you are not using SCSS for your Angular projects already, you really should.

The migration is very easy.

CSS / SASS

@import '~@nutrify/ngx-simple-spinner/scss/styles';

Angular

angular-cli.json:

"styles": [
  "styles.css",

  "../node_modules/@nutrify/ngx-simple-spinner/css/styles.css"
]