@impartner/design-components 1.0.0

package/LICENSE.txt

@@ -0,0 +1,11 @@
+Copyright 2023 Impartner, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,22 @@
+# `@impartner/design-components`
+
+This package contains [Angular](https://angular.io/) implementations of design components for the Impartner Hex design system, based on [Bootstrap 5](https://getbootstrap.com/).
+
+## Demo & Documentation
+
+Please check our [live Storybook documentation](https://design.impartner.com/) to peruse the available components and their documentation.
+
+## Dependencies
+
+In addition to core dependencies on Angular and RxJS, the package also depends on [NG Bootstrap](https://www.npmjs.com/package/@ng-bootstrap/ng-bootstrap), [Popper](https://www.npmjs.com/package/@popperjs/core), [Nano ID](https://www.npmjs.com/package/nanoid), and [`sanitize-html`](https://www.npmjs.com/package/sanitize-html). In addition, the Impartner Hex styles/CSS must be loaded and available on the page where these components are used. Impartner platform applications will always cover loading these styles, but usage in local development will need to also install and import CSS from the [`@impartner/design`](https://npmjs.com/package/@impartner/design) package.
+
+| @impartner/design-components | Angular | @impartner/design | ng-bootstrap | Popper | nanoid | sanitize-html |
+| ---------------------------- | ------- | ----------------- | ------------ | ------ | ------ | ------------- |
+| 1.0.x                        | 14.2.0  | 1.0.0             | 13.1.1       | 2.10.2 | 4.0.0  | 2.10.0        |
+
+## Installation
+
+1. Add the `@ng-bootstrap/ng-bootstrap`, `@popperjs/core`, `nanoid`, `sanitize-html`, and `@impartner/design-components` dependencies from npm.
+2. Import `DesignComponentsModule`, `ImpdcFormsModule`, or any other component-specific module into your own project's NgModules or standalone components.
+
+If the Impartner Hex stylesheet/CSS is desired, then install [`@impartner/design`](https://npmjs.com/package/@impartner/design) and refer to that package's own "Getting Started" instructions.

package/constants/fontawesome-icons.d.ts

@@ -0,0 +1,6 @@
+export declare const FontAwesomeIconThemes: string[];
+export declare type FontAwesomeIconTheme = typeof FontAwesomeIconThemes[number];
+export declare const FontAwesomeIcons: string[];
+export declare type FontAwesomeIcon = typeof FontAwesomeIcons[number];
+export declare const FontAwesomeFreeSolidIcons: FontAwesomeIcon[];
+export declare const FontAwesomeFreeRegularIcons: FontAwesomeIcon[];

package/constants/index.d.ts

@@ -0,0 +1 @@
+export * from './fontawesome-icons';