@prushforth/map 1.0.0-preview.1

package/dist/collection/fonts/icons/LICENSE.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2024, His Majesty in Right of Canada, as represented by the Minister of Employment and Social Development, with Reserved Font Name GCDS icons.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/collection/fonts/icons/README.md

@@ -0,0 +1,543 @@
+([Français](#polices-de-système-de-design-gc--icônes))
+
+# GC Design System Fonts - GCDS Icons
+
+GC Design System Fonts - GCDS Icons is a custom icon font created for the GC Design System. Icon fonts provide scalable vector icons that enhance performance, maintain consistency, and offer easy customization through CSS. Icons are used for visual communication that helps a person understand context.
+
+To remove the reliance on a third-party icon library (Font Awesome) we built a custom icon font. This also provides the GC Design System with more control over icons available to users. FontAwesome provides an extensive collection of icons, most of which will not be used for our components. By limiting the scope of available icons, we aim to prevent misuse and provide clear guidelines on the appropriate usage of each icon.
+
+## Installation
+
+### Install icon font with CDN
+
+#### Add the code
+
+Use the latest version of GC Design System icons. Pinned versions provide stability and predictability because the code will remain consistent and won't change unexpectedly, which can be crucial for maintaining the stability of an application. However, it requires manual updating of the CDN links whenever a newer version of GC Design System icons is released.
+
+To use GC Design System icons in your project, place the following code in your CSS or include the [gcds-icons.css](https://github.com/cds-snc/gcds-fonts/blob/main/fonts/icons/gcds-icons.css) file in your project. Replace `<version-number>` with the latest version number to receive corresponding updates.
+
+```css
+<!-- GC Design System Fonts - Icons -->
+@font-face {
+  font-family: "gcds-icons";
+  src: url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.eot");
+  src: url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.eot#iefix")
+      format("embedded-opentype"), url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.ttf")
+      format("truetype"),
+    url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.woff")
+      format("woff"), url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.svg")
+      format("svg");
+  font-weight: normal;
+  font-style: normal;
+  font-display: block;
+}
+
+[class^="gcds-icon-"],
+[class*=" gcds-icon-"] {
+  /* use !important to prevent issues with browser extensions that change fonts */
+  font-family: "gcds-icons" !important;
+  speak: never;
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  text-transform: none;
+  line-height: 1;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+.gcds-icon-arrow-down:before {
+  content: "\f013";
+}
+
+.gcds-icon-arrow-up:before {
+  content: "\f011";
+}
+
+.gcds-icon-arrow-up-down:before {
+  content: "\f012";
+}
+
+.gcds-icon-checkmark-circle:before {
+  content: "\f021";
+}
+
+.gcds-icon-chevron-down:before {
+  content: "\f020";
+}
+
+.gcds-icon-chevron-left:before {
+  content: "\f01f";
+}
+
+.gcds-icon-chevron-right:before {
+  content: "\f01e";
+}
+
+.gcds-icon-chevron-up:before {
+  content: "\f01d";
+}
+
+.gcds-icon-close:before {
+  content: "\f01c";
+}
+
+.gcds-icon-download:before {
+  content: "\f01b";
+}
+
+.gcds-icon-email:before {
+  content: "\f01a";
+}
+
+.gcds-icon-exclamation-circle:before {
+  content: "\f019";
+}
+
+.gcds-icon-external:before {
+  content: "\f018";
+}
+
+.gcds-icon-filter:before {
+  content: "\f005";
+}
+
+.gcds-icon-info-circle:before {
+  content: "\f017";
+}
+
+.gcds-icon-phone:before {
+  content: "\f016";
+}
+
+.gcds-icon-search:before {
+  content: "\f002";
+}
+
+.gcds-icon-sort:before {
+  content: "\f003";
+}
+
+.gcds-icon-tune:before {
+  content: "\f000";
+}
+
+.gcds-icon-warning-triangle:before {
+  content: "\f014";
+}
+```
+
+#### Automatic updates using `@latest`
+
+Use the `@latest` version of GC Design System icons to receive automatic updates whenever a new version is released. **While it removes the need to manually update the CDN links, it adds the risk of introducing breaking changes to the codebase as new versions are automatically applied**.
+
+### Install icon font with npm
+
+Navigate to the root folder of your project and run:
+
+```js
+npm install @gcds-core/fonts
+```
+
+Place the following code in your CSS and replace `path/to/node_modules` with the location where you've added the node modules:
+
+```css
+<!-- GC Design System Fonts - Icons -->
+@font-face {
+  font-family: "gcds-icons";
+  src: url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.eot");
+  src: url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.eot#iefix")
+      format("embedded-opentype"), url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.ttf")
+      format("truetype"),
+    url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.woff")
+      format("woff"), url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.svg")
+      format("svg");
+  font-weight: normal;
+  font-style: normal;
+  font-display: block;
+}
+
+[class^="gcds-icon-"],
+[class*=" gcds-icon-"] {
+  /* use !important to prevent issues with browser extensions that change fonts */
+  font-family: "gcds-icons" !important;
+  speak: never;
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  text-transform: none;
+  line-height: 1;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+.gcds-icon-arrow-down:before {
+  content: "\f013";
+}
+
+.gcds-icon-arrow-up:before {
+  content: "\f011";
+}
+
+.gcds-icon-arrow-up-down:before {
+  content: "\f012";
+}
+
+.gcds-icon-checkmark-circle:before {
+  content: "\f021";
+}
+
+.gcds-icon-chevron-down:before {
+  content: "\f020";
+}
+
+.gcds-icon-chevron-left:before {
+  content: "\f01f";
+}
+
+.gcds-icon-chevron-right:before {
+  content: "\f01e";
+}
+
+.gcds-icon-chevron-up:before {
+  content: "\f01d";
+}
+
+.gcds-icon-close:before {
+  content: "\f01c";
+}
+
+.gcds-icon-download:before {
+  content: "\f01b";
+}
+
+.gcds-icon-email:before {
+  content: "\f01a";
+}
+
+.gcds-icon-exclamation-circle:before {
+  content: "\f019";
+}
+
+.gcds-icon-external:before {
+  content: "\f018";
+}
+
+.gcds-icon-filter:before {
+  content: "\f005";
+}
+
+.gcds-icon-info-circle:before {
+  content: "\f017";
+}
+
+.gcds-icon-phone:before {
+  content: "\f016";
+}
+
+.gcds-icon-search:before {
+  content: "\f002";
+}
+
+.gcds-icon-sort:before {
+  content: "\f003";
+}
+
+.gcds-icon-tune:before {
+  content: "\f000";
+}
+
+.gcds-icon-warning-triangle:before {
+  content: "\f014";
+}
+```
+
+## How to use icons
+
+Open the [icons overview]() to see a list of all available GC Design System icons and find the icon class name of the icon you want to use. Apply the class to any HTML element where you want the icon to appear. Replace `gcds-icon-name` with the specific class name for the icon you want to use.
+
+```html
+<span class="gcds-icon-name"></span>
+```
+
+If you want to use the close icon, for example, you need to add the class `gcds-icon-close`:
+
+```html
+<span class="gcds-icon-close"></span>
+```
+
+## Example
+
+Open the [icons overview]() to see a list of all available GC Design System icons. You can find the code for the icons overview page in the [examples folder](https://github.com/cds-snc/gcds-fonts/tree/main/examples/icons).
+
+---
+
+# Polices de Système de design GC — GCDS Icônes
+
+Polices de Système de design GC — GCDS Icônes est une police d'icônes sur mesure créée pour Système de design GC. Les polices d'icônes fournissent des icônes vectorielles redimensionnables qui améliorent la performance, assurent l'uniformité et offrent une personnalisation facile par le biais de CSS. Les icônes sont utilisées pour communiquer visuellement et aider les gens à comprendre le contexte.
+
+Pour éviter de recourir à une bibliothèque d'icônes tierce (Font Awesome), nous avons créé une police d'icônes sur mesure. Nous pouvons ainsi mieux contrôler les icônes mises à la disposition des utilisatrices et utilisateurs de Système de design GC. Font Awesome fournit une vaste collection d'icônes, dont la plupart ne seront pas utilisées pour nos composants. En limitant la quantité d'icônes disponibles, nous visons à prévenir les mauvais usages et à fournir des directives claires sur l'usage approprié de chaque icône.
+
+## Installation
+
+### Installer la police d'icônes avec le CDN
+
+#### Ajoutez le code
+
+Utilisez la version la plus récente de icônes de Système de design GC. Les versions épinglées offrent stabilité et prévisibilité parce que le code ne changera pas de manière inattendue, ce qui peut être crucial pour maintenir la stabilité d'une application. Toutefois, il faut mettre à jour manuellement les liens CDN chaque fois qu'une version plus récente de icônes de Système de design GC est publiée.
+
+Pour utiliser les icônes de Système de design GC dans votre projet, placez le code suivant dans votre CSS ou incluez le fichier [gcds-icons.css](https://github.com/cds-snc/gcds-fonts/blob/main/fonts/icons/gcds-icons.css) dans votre projet. Remplacez `<version-number>` par le numéro de version le plus récent pour recevoir les mises à jour correspondantes.
+
+```css
+<!-- Polices de Système de design GC — Icônes -->
+@font-face {
+  font-family: "gcds-icons";
+  src: url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.eot");
+  src: url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.eot#iefix")
+      format("embedded-opentype"), url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.ttf")
+      format("truetype"),
+    url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.woff")
+      format("woff"), url("https://cdn.design-system.canada.ca/@gcds-core/fonts@<version-number>/icons/gcds-icons.svg")
+      format("svg");
+  font-weight: normal;
+  font-style: normal;
+  font-display: block;
+}
+
+[class^="gcds-icon-"],
+[class*=" gcds-icon-"] {
+  /* use !important to prevent issues with browser extensions that change fonts */
+  font-family: "gcds-icons" !important;
+  speak: never;
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  text-transform: none;
+  line-height: 1;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+.gcds-icon-arrow-down:before {
+  content: "\f013";
+}
+
+.gcds-icon-arrow-up:before {
+  content: "\f011";
+}
+
+.gcds-icon-arrow-up-down:before {
+  content: "\f012";
+}
+
+.gcds-icon-checkmark-circle:before {
+  content: "\f021";
+}
+
+.gcds-icon-chevron-down:before {
+  content: "\f020";
+}
+
+.gcds-icon-chevron-left:before {
+  content: "\f01f";
+}
+
+.gcds-icon-chevron-right:before {
+  content: "\f01e";
+}
+
+.gcds-icon-chevron-up:before {
+  content: "\f01d";
+}
+
+.gcds-icon-close:before {
+  content: "\f01c";
+}
+
+.gcds-icon-download:before {
+  content: "\f01b";
+}
+
+.gcds-icon-email:before {
+  content: "\f01a";
+}
+
+.gcds-icon-exclamation-circle:before {
+  content: "\f019";
+}
+
+.gcds-icon-external:before {
+  content: "\f018";
+}
+
+.gcds-icon-filter:before {
+  content: "\f005";
+}
+
+.gcds-icon-info-circle:before {
+  content: "\f017";
+}
+
+.gcds-icon-phone:before {
+  content: "\f016";
+}
+
+.gcds-icon-search:before {
+  content: "\f002";
+}
+
+.gcds-icon-sort:before {
+  content: "\f003";
+}
+
+.gcds-icon-tune:before {
+  content: "\f000";
+}
+
+.gcds-icon-warning-triangle:before {
+  content: "\f014";
+}
+```
+
+#### Mises à jour automatiques grâce à `@latest`
+
+Utilisez la version `@latest` de icônes de Système de design GC pour recevoir des mises à jour automatiques chaque fois qu'une nouvelle version est publiée. **Bien que cette approche vous évite la mise à jour manuelle des liens CDN, elle court le risque d'introduire des modifications qui entraînent une rupture de compatibilité avec le code base à mesure que les nouvelles versions sont automatiquement appliquées**.
+
+### Installer la police d'icônes avec npm
+
+Naviguez jusqu'au dossier racine de votre projet et exécutez :
+
+```js
+npm install @gcds-core/fonts
+```
+
+Placez le code suivant dans votre CSS et remplacez `path/to/node_modules` par l'emplacement où vous avez ajouté les modules de Node :
+
+```css
+<!-- Polices de Système de design GC — Icônes -->
+@font-face {
+  font-family: "gcds-icons";
+  src: url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.eot");
+  src: url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.eot#iefix")
+      format("embedded-opentype"), url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.ttf")
+      format("truetype"),
+    url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.woff")
+      format("woff"), url("path/to/node_modules/@gcds-core/fonts/fonts/icons/gcds-icons.svg")
+      format("svg");
+  font-weight: normal;
+  font-style: normal;
+  font-display: block;
+}
+
+[class^="gcds-icon-"],
+[class*=" gcds-icon-"] {
+  /* use !important to prevent issues with browser extensions that change fonts */
+  font-family: "gcds-icons" !important;
+  speak: never;
+  font-style: normal;
+  font-weight: normal;
+  font-variant: normal;
+  text-transform: none;
+  line-height: 1;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+.gcds-icon-arrow-down:before {
+  content: "\f013";
+}
+
+.gcds-icon-arrow-up:before {
+  content: "\f011";
+}
+
+.gcds-icon-arrow-up-down:before {
+  content: "\f012";
+}
+
+.gcds-icon-checkmark-circle:before {
+  content: "\f021";
+}
+
+.gcds-icon-chevron-down:before {
+  content: "\f020";
+}
+
+.gcds-icon-chevron-left:before {
+  content: "\f01f";
+}
+
+.gcds-icon-chevron-right:before {
+  content: "\f01e";
+}
+
+.gcds-icon-chevron-up:before {
+  content: "\f01d";
+}
+
+.gcds-icon-close:before {
+  content: "\f01c";
+}
+
+.gcds-icon-download:before {
+  content: "\f01b";
+}
+
+.gcds-icon-email:before {
+  content: "\f01a";
+}
+
+.gcds-icon-exclamation-circle:before {
+  content: "\f019";
+}
+
+.gcds-icon-external:before {
+  content: "\f018";
+}
+
+.gcds-icon-filter:before {
+  content: "\f005";
+}
+
+.gcds-icon-info-circle:before {
+  content: "\f017";
+}
+
+.gcds-icon-phone:before {
+  content: "\f016";
+}
+
+.gcds-icon-search:before {
+  content: "\f002";
+}
+
+.gcds-icon-sort:before {
+  content: "\f003";
+}
+
+.gcds-icon-tune:before {
+  content: "\f000";
+}
+
+.gcds-icon-warning-triangle:before {
+  content: "\f014";
+}
+```
+
+## Comment utiliser les icônes
+
+Ouvrez l'[aperçu des icônes]() pour afficher la liste de toutes les icônes de Système de design GC disponibles et trouver le nom de classe de l'icône que vous souhaitez utiliser. Appliquez la classe à n'importe quel élément HTML auquel vous voulez ajouter l'icône. Remplacez `gcds-icon-name` par le nom de classe de l'icône que vous souhaitez utiliser.
+
+```html
+<span class="gcds-icon-name"></span>
+```
+
+Si vous voulez utiliser l'icône « fermer », par exemple, vous devez ajouter la classe `gcds-icon-close` :
+
+```html
+<span class="gcds-icon-close"></span>
+```
+
+## Exemple
+
+Ouvrez l'[aperçu des icônes]() pour afficher la liste de toutes les icônes de Système de design GC disponibles. Vous trouverez le code accompagnant l'aperçu des icônes dans le dossier [exemples](https://github.com/cds-snc/gcds-fonts/tree/main/examples/icons).