npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@alexfriesen/ngx-mat-timepicker

v18.0.2

Published

ngx-mat-timepicker is an Angular material 17+ extension to add time pickers!

Downloads

782

Readme

@alexfriesen/ngx-mat-timepicker

npm MIT licensed Build state Size

A simple time picker module using Angular Material: it provides an Android style dialog for time selection and a handy input for time selection in Material style.

Table of contents

Getting started

Install timepicker through npm:

npm i --save @alexfriesen/ngx-mat-timepicker

Next import the timepicker module into your app's module:

import { NgModule } from '@angular/core';
import { NgxMatTimepickerModule } from '@alexfriesen/ngx-mat-timepicker';

@NgModule({
  imports: [NgxMatTimepickerModule],
})
export class MyModule {}

Finally connect the timepicker to an input via a template property:

<input [ngxMatTimepicker]="picker" />
<ngx-mat-timepicker #picker />

The timepicker opens once you click on the input

Internationalization

Timepicker supports locales in format BCP 47. It has en-US locale by default.

To override default locale:

import { NgModule } from '@angular/core';
import { NgxMatTimepickerModule } from '@alexfriesen/ngx-mat-timepicker';

@NgModule({
  imports: [NgxMatTimepickerModule.setLocale('en-GB')],
})
export class MyModule {}

Theming

This Package relies on an existing Angular Material Theme:

@import '@angular/material/prebuilt-themes/indigo-pink.css';

or

@use '@angular/material' as mat;

@include mat.all-component-themes($my-theme);

Documentation

API reference for Angular Material Timepicker

import { NgxMatTimepickerModule } from '@alexfriesen/ngx-mat-timepicker';

NgxMatTimepicker

Directive responsible for managing the timepicker popup and setting value to input

Selector: ngxMatTimepicker

Properties

| Name | Description | | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | @Input() ngxMatTimepicker: NgxMatTimepickerComponent | The timepicker that this input is associated with. | | @Input() color: ThemePalette | The material palette to use. | | @Input() disabled: boolean | Weather the timepicker popup should be disabled. | | @Input() value: string | Set a default value and time for a timepicker. The format of the time is in 12 hours notation 11:00 PM or in 24 hours notation 23:00. A Date string won't work. | | @Input() format: number | 12 or 24 . 12h/24h view for hour selection clock . 12 (AM/PM) format by default. | | @Input() min: string or DateTime | Set min time for timepicker (11:15 pm ) | | @Input() max: string or DateTime | Set max time for timepicker (11:15 pm ) | | @Input() disableClick: boolean | Set true to disable opening timepicker by clicking on the input |

NgxMatTimepickerLocaleService

This service allows to change the locale anytime.
You can inject this in your component or extend and provide your version, in order to provide your current locale to all the pickers!
At this time is semi-static, which means you can't change the locale for pickers that are already opened.
But new pickers will always get the updated locale.

NgxMatTimepickerComponent

Component responsible for visualisation the timepicker

Selector: ngx-mat-timepicker

Properties

| Name | Description | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | @Input() cancelBtnTmpl: TemplateRef | Set if you want to change cancel button to your custom one. | | @Input() confirmBtnTmpl: TemplateRef | Set if you want to change confirm button to your custom one. | | @Input() editableHintTmpl: TemplateRef | Set if you want to change dial hint to your custom one. Works only if enableKeyboardInput = true | | @Input() ESC: boolean | Disable or enable closing timepicker by ESC. | | @Input() enableKeyboardInput: boolean | To disable or enable changing time through a keyboard on the timepicker dial without interaction with a clock face. Set false by default | | @Input() minutesGap: number | To define a gap between minutes. Set 1 by default | | @Input() defaultTime: string | Set default time for a timepicker. 12:00 AM by default | | @Input() preventOverlayClick: boolean | Set true to prevent closing the timepicker by overlay click. Uses false by default | | @Input() disableAnimation: boolean | Set true to prevent opening and closing timepicker animation. Uses false by default | | @Input() hoursOnly: boolean | Set true to prevent switching to minutes automatically once hour is selected. Uses false by default | | @Input() theme: NgxMatTimepickerTheme | Custom css properties which will override the defaults | | @Input() timepickerClass: string | To provide a custom css class for the timepicker | | @Output() timeSet: EventEmitter<string> | Emits time when that was set. | | @Output() opened: EventEmitter<null> | Emits after timepicker was opened. | | @Output() closed: EventEmitter<null> | Emits after timepicker was closed. | | @Output() hourSelected: EventEmitter<number> | Emits after hour was selected. | | @Output() timeChanged: EventEmitter<string> | Emits once time was changed. |

NgxMatTimepickerFieldComponent

The timepicker as a control.

Selector: ngx-mat-timepicker-field

Properties

| Name | Description | | ----------------------------------------------------- | --------------------------------------------------------------------------- | | @Input() disabled: boolean | Whether the timepicker is disabled | | @Input() floatLabel: 'never' or 'always' or 'auto' | Whether the labels of the fields should float, default to never | | @Input() toggleIcon: TemplateRef<HTMLObjectElement> | Provide custom svg icon for toggle button | | @Input() buttonAlign: 'right' or 'left' | Positioning toggle button (right by default) | | @Input() clockTheme: NgxMatTimepickerTheme | Custom css properties which will override timepicker clock | | @Input() controlOnly: boolean | Hide or display toggle button with the timepicker clock | | @Input() format: number | 12 or 24 . Set format for timepicker. 12 (AM/PM) format by default. | | @Input() cancelBtnTmpl: TemplateRef<Node> | Set if you want to change cancel button for timepicker to your custom one. | | @Input() confirmBtnTmpl: TemplateRef<Node> | Set if you want to change confirm button for timepicker to your custom one. | | @Input() min: string or DateTime | Set min time for timepicker (11:15 pm ) | | @Input() max: string or DateTime | Set max time for timepicker (11:15 pm ) |

| @Output()
timeChanged: EventEmitter<string> | Emit a new time once it is changed. |

NgxMatTimepickerToggleComponent

Component responsible for opening the timepicker.

Selector: ngx-mat-timepicker-toggle

Properties

| Name | Description | | --------------------------------------- | ----------------------------------------------- | | @Input() for: NgxMatTimepickerComponent | Timepicker instance that the button will toggle | | @Input() disabled: boolean | Whether the toggle button is disabled |

NgxMatTimepickerToggleIconDirective

Can be used to override the icon of a NgxMatTimepickerToggleComponent.

Selector: [ngxMatTimepickerToggleIcon]

Properties

| Name | Description | | ----------------------------------------------------- | ------------------------------------------------------ | | @Input() ngxMatTimepickerTheme: NgxMatTimepickerTheme | Custom css properties which will override the defaults |

Demo

Demo

$ npm
$ npm start

Run npm test to run tests once.

License

This project is licensed under the MIT License - see the LICENSE file for details

Thanks to

LayZeeDK - For his great work on the unit tests and upgrades for v15 "legacy"

Agranom for setting up the original repo.