\r\nThe best way to quickly integrate Zurb Foundation for Sites (6.4 or later) components with Angular 6 or 7. This is a fork of ngx-bootstrap by Valor Software. No jQuery is required to implement with your Angular project.\r\n
\r\n\r\n## Links\r\n- [Documentation and Code Examples](https://ngxfoundation.com)\r\n- [Changelog and Release Notes](https://github.com/nthompson777/ngx-foundation/blob/master/CHANGELOG.md)\r\n\r\n\r\n## Table of contents\r\n1. [Getting Started](#getting-started)\r\n2. [Installation Instructions](#installation-instructions)\r\n3. [API and Demo](#api-and-demo)\r\n4. [Starter Kit](#starter-kit)\r\n5. [Troubleshooting](#troubleshooting)\r\n6. [License](#license)\r\n\r\n## Getting Started\r\n\r\nngx-foundation contains all core Foundation components powered by Angular. There is no need to include original JS components, but we are using markup and SCSS provided by Foundation for Sites.\r\n\r\n[See the ngx-foundation website](https://www.ngxfoundation.com/getting-started) for detailed setup instructions, SCSS /style.scss setup file example and more....\r\n\r\n## Installation instructions\r\n\r\nInstall `ngx-foundation` from `yarn` or `npm`:\r\n```bash\r\nyarn add ngx-foundation\r\nnpm i ngx-foundation\r\n```\r\n\r\nAdd needed package to NgModule imports:\r\n```\r\nimport { TooltipModule } from 'ngx-foundation';\r\n\r\n@NgModule({\r\n ...\r\n imports: [TooltipModule.forRoot(),...]\r\n ...\r\n})\r\n```\r\n\r\nAdd component to your page:\r\n```\r\n\r\n```\r\n\r\nList of available modules for import:\r\n\r\n```\r\nimport {\r\n AccordionModule,\r\n AlertModule, // Foundation Callouts\r\n ButtonsModule,\r\n CarouselModule, // Foundation Orbit\r\n CollapseModule,\r\n BsDatepickerModule,\r\n BsDropdownModule, // Foundation Dropdown Menus and Dropdown Panes\r\n ModalModule, // Foundation Reveal\r\n OffcanvasModule,\r\n PaginationModule,\r\n ProgressbarModule,\r\n RatingModule,\r\n SortableModule,\r\n TabsModule,\r\n TimepickerModule,\r\n TooltipModule,\r\n TypeaheadModule,\r\n} from 'ngx-foundation';\r\n```\r\n### Add ngx-foundation and Foundation SCSS Base Styles\r\nImport ngx-foundation base styles to your main `src/styles.scss` file:\r\n\r\n```\r\n// Import Foundation for Sites\r\n// See https://foundation.zurb.com/sites/docs/sass.html for detailed info.\r\n@import '~foundation-sites/scss/foundation';\r\n @include foundation-everything;\r\n\r\n// Import Angular ngx-foundation Framework Added Styles\r\n@import \"~ngx-foundation/assets/scss/main\";\r\n```\r\n\r\nDownload the [ngx-foundation Starter Kit](https://github.com/nthompson777/ngx-foundation-starterkit) (uses Angular 7, Foundation for Sites using SCSS, and ngx-foundation) to get up and running quickly.\r\n\r\n### CSS Only \r\nIf you're going the flat CSS only route you will need Foundation 6 and ngx-foundation base styles:\r\n- `Foundation 6`\r\n```\r\n\r\n\r\n```\r\n- `ngx-foundation`\r\n```\r\n\r\n\r\n```\r\n\r\n## API and Demo\r\n\r\nAPI documentation and usage scenarios available here:\r\n[https://ngxfoundation.com](https://ngxfoundation.com)\r\n\r\n### Starter Kit\r\n\r\nWant to get your ngx-foundation project up and running quickly? Use the [ngx-foundation Starter Kit](https://github.com/nthompson777/ngx-foundation-starterkit) (uses Angular 7, Foundation for Sites using SCSS, and ngx-foundation) with detailed instructions and includes all necessary base assets and components. \r\n\r\n## Troubleshooting\r\n\r\nThe best place to ask questions is on [StackOverflow (under the `ngx-foundation` tag)](https://stackoverflow.com/questions/tagged/ngx-foundation)\r\n\r\n### License\r\n\r\nMIT\r\n","readmeFilename":"README.md"}