3.0.2 • Published 6 years ago

ngx-zf-foundation v3.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Links

Table of contents

  1. Getting Started
  2. Installation instructions
  3. Usage & Demo
  4. API
  5. Troubleshooting
  6. Contributing

Getting Started

ngx-bootstrap contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and css provided by Bootstrap.

Installation instructions

Install ngx-zf-foundation from yarn:

yarn add ngx-zf-foundation --save

Add needed package to NgModule imports:

import { TooltipModule } from 'ngx-bootstrap/tooltip';

@NgModule({
  ...
  imports: [TooltipModule.forRoot(),...]
  ...
})

Add component to your page:

<button type="button" class="btn btn-primary"
        tooltip="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Simple demo
</button>

You will need Foundation 6 styles:

  • Foundation 6
<!-- index.html -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/foundation/6.4.3/css/foundation.min.css" rel="stylesheet">

Setting up the Foundation version manually

Sometimes, your project might contain some library that could interfear with the Foundation framework, or you might have a customized version of Foundation:

Instructions here.............

Usage & Demo

Main source of API documentation and usage scenarios available here: https://valor-software.com/ngx-bootstrap/

Additionally you can find demos and docs deployed from latest code with angular v4 and angular v5

Server side rendered version of this documentation available here

API

Check demo page for API reference

How to use it with:

How to build lib for development

First time:

  • clone repository
  • npm install
  • npm run test

To update your fork and prepare it for local usage:

  • git pull upstream development
  • rm -rf node_modules
  • npm install
  • npm run test // it will build the lib, create a link in node_modules and run package's "test" script

To run the demo:

  • npm run demo.serve // to serve local demo. This is for testing only, without watchers.

For local development run:

  • npm run build.watch // in first terminal
  • ng serve // in second

Troubleshooting

So if you are in trouble, here's where you can look for help.

The best place to ask questions is on StackOverflow (under the ngx-zf-foundation tag)

If, and only if, none of the above helped, please open a new issue.

License

MIT