Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

angular-tabs-component

1.0.6 • Public • Published

angular-tabs-component

A full featured tab component for Angular (2 and above, including 4).

I have used tabs so many times but i never found a tab component basic and simple enough to use in angular 2/4.

So, i decided to build one for Angular, with all the basic features-

  • Simple to use
  • Well Documented
  • CSS for active tab
  • NGC compatible
  • Supports AOT
  • Supports disabling and setting active tab
  • Easily styled (comes with very minimal styling)

If you like this, support the project by starring it!

Angular supported version

angular-tabs-component supports angular 2.X.X releases, 4.X.X releases, and AoT compilation.

Example

To install the library:

npm install angular-tabs-component

Include the library into your app module-

import 'TabModule' from 'angular-tabs-component';

Add it to your @NgModule imports-

@NgModule({
  imports: [
    BrowserModule
    ...,
    ...,
    TabModule
  ],
  declarations: [...],
  ...
})

Usage

<tabs>
  <tab tabTitle="Foo">
    I am the foo content
  </tab>
  <tab tabTitle="Bar">
    I am the bar content
  </tab>
<tabs>

Options

Apart from the default settings, there are a number of options that can be specified for the tab components. Options are specified by directly adding it to the element as attribute with property binding, attribute binding and event binding. Possible options are:

  • tabTitle (applicable to: tab, property): To set the title of that tab (required).
  • active (applicable to: tab, property): To set any tab as by default active - Usage:
    <tabs>
      <tab tabTitle="Foo">
        I am the foo content
      </tab>
      <tab tabTitle="Bar" active="true">
        I am the bar content
      </tab>
    <tabs>
    
  • disabled (applicable to: tabs, property): To set the tabs disabled. Usage:
    <tabs disabled="true">
      <tab tabTitle="Foo">
        I am the foo content
      </tab>
      <tab tabTitle="Bar">
        I am the bar content
      </tab>
    <tabs>
    
  • currentTabChange (applicable to: tabs, event): Notifies every time the tab is switched with the tab component object. Usage:
    <tabs (currentTabChange)="notifyMe($event)">
      <tab tabTitle="Foo">
        I am the foo content
      </tab>
      <tab tabTitle="Bar">
        I am the bar content
      </tab>
    <tabs>
    

What's next

I would always love to hear suggestions for features & improvements - just open an issue.

Some things on our mind down the road:

  • Add more tests
  • Add more examples

Please check the issues / project before starting to work on a feature / bug to make sure it's not already in progress.

Install

npm i angular-tabs-component

DownloadsWeekly Downloads

1,672

Version

1.0.6

License

MIT

Last publish

Collaborators

  • avatar