1.2.2 • Published 4 years ago

ngb-card v1.2.2

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

ngb-card - Boostrap 4 Powered Angular Card with optional Snippet code feature.

npm version Build Status Sauce Test Status

Angular widgets built from the ground up using only Bootstrap 4 CSS with APIs designed for the Angular ecosystem.

Table of Contents

Demo

Please check all advance features we have in action at https://innovthemes.github.io/ngb-card

Dependencies

The only four dependencies are ng-bootstrap for advance features. Bootstrap 4 for Styling. ngx-highlightjs for snippet code. The supported versions are:

Installation

Just run the following:

npm install --save ngb-card

Initial Configuration

app.module.ts

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

import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';

import { NgbCardModule } from 'projects/ngb-card/src/public-api'; // <------

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,
    NgbCardModule // <------
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Open polyfills.ts ADD BELOW LINE AT BOTTOM

import '@angular/localize/init';

Note: If you get error while compilation then recompile the whole angular project by running ng serve again

Example

  1. Basic Card 1.1 component.html
    <ngb-card [footerClass]="'text-danger'">
       <div class="ngb-card-header">Card Header</div>
       <div class="ngb-card-body text-center">
          <div class="mx-auto mt-2">
             <img class="img-fluid"
                src="https://p.kindpng.com/picc/s/715-7155174_professional-headshots-men-asian-png-download-professional-profile.png"
                width="70" alt="img placeholder" />
          </div>
          <h4>Gerry Dillon</h4>
          <p class="">Designer</p>
          <div class="d-flex justify-content-between">
             <small class="float-left font-weight-bold" id="example-caption-3">720 Points</small>
             <small class="float-right font-weight-bold" id="example-caption-4">1000</small>
          </div>
          <div class="progress box-shadow my-3">
             <div class="progress-bar bg-success" role="progressbar" aria-valuenow="45" aria-valuemin="45"
                aria-valuemax="100" style="width: 45%;" aria-describedby="example-caption-3"></div>
          </div>
          <div class="d-flex justify-content-between">
             <button class="btn btn-primary">
                Follow
             </button>
             <button class="btn btn-outline-primary">
                Message
             </button>
          </div>
       </div>
       <div class="ngb-card-footer">Card Footer</div>
    </ngb-card>    
    1.2 Output
  1. Advance Card

    2.1 component.html

    <ngb-card [headerClass]="'h3 text-primary'" [footerClass]="'text-danger'" [codeSnippet]="snippetCodeVariable">
       <div class="ngb-card-header">Card Header</div>
       <div class="ngb-card-body text-center">
          <div class="mx-auto mt-2">
             <img class="img-fluid"
                src="https://p.kindpng.com/picc/s/715-7155174_professional-headshots-men-asian-png-download-professional-profile.png"
                width="70" alt="img placeholder" />
          </div>
          <h4>Gerry Dillon</h4>
          <p class="">Designer</p>
          <div class="d-flex justify-content-between">
             <small class="float-left" id="ngb-card-advance">720 Points</small>
             <small class="float-right" id="ngb-card-advance">1000</small>
          </div>
          <div class="progress shadow-sm my-3">
             <div class="progress-bar bg-success" role="progressbar" aria-valuenow="45" aria-valuemin="45"
                aria-valuemax="100" style="width: 45%;" aria-describedby="ngb-card-advance"></div>
          </div>
          <div class="d-flex justify-content-between">
             <button class="btn btn-primary">
                Follow
             </button>
             <button class="btn btn-outline-primary">
                Message
             </button>
          </div>
       </div>
       <div class="ngb-card-footer">Card Footer</div>
    </ngb-card>

    2.2 component.ts

    import { Component } from '@angular/core';
    import { CodeSnippet } from 'projects/ngb-card/src/public-api';
    
    @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.scss'],
    })
    export class AppComponent {
      public snippetCodeVariable: CodeSnippet = {
        html: `// HTML snippet code
    <ngb-card [footerClass]="'text-danger'">
      <div class="ngb-card-header">Card Header</div>
      <div class="ngb-card-body">
          ...
      </div>
      <div class="ngb-card-footer">Card Footer</div>
    </ngb-card>`,
        ts: `// typescript snippet code
    @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.scss'],
    })`,
        css: `// CSS code
    #demo-code{
      color: blue;
    }
    .demo-code{
      background-color: white;
    }
        `,
        scss: `// SCSS code
    #demo-code, .demo-code{
      color: blue;
      background-color: white;
    }
        `,
        json: `// json snippet code
    {
      "user_id": "234",
      "name": “Mk Hollida
      "email": “mock.holliday@example.com",
      "birthdate": "1971-08-01T00:00:00+00:00”
    }`,
        service: `// Angular service snippet code
    import { Injectable } from '@angular/core';
    
    @Injectable({
      providedIn: 'root',
    })
    export class HeroService {
    
      constructor() { }
    
    }`,
        module: `// Angular module snippet code
    @NgModule({
      declarations: [
        AppComponent
      ],
      imports: [
        BrowserModule,
        AppRoutingModule,
        NgbCardModule
      ],
      providers: [],
      bootstrap: [AppComponent]
    })
        `,
      };
    }

    2.3 Output :

API

SelectorTypepropertyDiscription
ngb-cardselectorelementngb-card component
cardClassInputclassUse cardClass input property to add class to card.
headerClassInputclassUse headerClass input property to add class to card header.
bodyClassInputclassUse bodyClass input property to add class to card body.
footerClassInputclassUse footerClass input property to add class to card footer
codeSnippetCodeSnippetobjectCreate HTML | TS | SCSS | CSS | JSON | SERVICE | MODULE code snippets with tabs by passing html | ts | scss| | css | json | service | module as key value pair to the snippetCode input Property.

Supported browsers

We support the same browsers and versions supported by both Bootstrap 4 and Angular, whichever is more restrictive. See Angular browser support and Bootstrap browser support for more details.

Our code is automatically tested on all supported browsers.

Getting help

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on StackOverflow where maintainers are looking at questions tagged with ngb-card or you can directly chat with us chat icon at bottom right corner at https://innovthemes.com/.

StackOverflow is a much better place to ask questions since:

  • there are hundreds of people willing to help on StackOverflow
  • questions and answers stay available for public viewing so your question / answer might help someone else
  • SO voting system assures that the best answers are prominently visible.

To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.

You think you've found a bug?

We want to fix it ASAP! But before fixing a bug we need to reproduce and confirm it.

We ask you to respect two things:

  • fill the GitHub issue template by providing the bug description and appropriate versions of Angular, ng-bootstrap and TypeScript.
  • provide a use-case that fails with a minimal reproduction scenario using StackBlitz (you can start by forking one from our github page)

A minimal reproduction scenario allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.