Toggle

Toggle a button on and off.

Usage

Assemble the toggle directives in your template.

<div ngpToggle></div>

API Reference

The following directives are available to import from the @ng-primitives/ng-primitives/toggle package:

NgpToggleDirective

There are no inputs or outputs for this directive.

Global Configuration

You can configure the default options for all toggles in your application by using the provideNgpToggleConfig function in a providers array.

import { provideNgpToggleConfig } from '@ng-primitives/ng-primitives/toggle';

bootstrapApplication(AppComponent, {
  providers: [provideNgpToggleConfig({})],
});

NgpToggleConfig

Schematics

You can use our schematic to generate a new toggle component.

Angular CLI

ng generate @ng-primitives/ng-primitives:toggle

Options

name · string

The name of the component.

project · string

The name of the project to add the component to.

path · string

The path to create the component.