@ongov/ontario-design-system-component-library 4.3.0-alpha.3 → 4.3.1-alpha.1

package/src/translations/global.i18n.json

@@ -1,155 +1,55 @@
 {
-	"required": {
-		"en": "required",
-		"fr": "obligatoire"
-	},
-	"optional": {
-		"en": "optional",
-		"fr": "facultative"
-	},
 	"accessibility": {
-		"moreInfo": {
-			"en": "More information on",
-			"fr": "Des renseignements supplémentaires sur"
-		},
 		"checkboxHintExpander": {
 			"en": "is available after the last checkbox item.",
 			"fr": "suivront à la dernière case à cocher."
 		},
+		"moreInfo": {
+			"en": "More information on",
+			"fr": "Des renseignements supplémentaires sur"
+		},
 		"singleHintExpander": {
 			"en": "field is available in the next element.",
 			"fr": "suivront au prochain élément."
 		}
 	},
-	"backToTop": {
-		"top": {
-			"en": "Top",
-			"fr": "Haut"
-		},
-		"ariaLabel": {
-			"en": "Scroll back to the top",
-			"fr": "Retour en haut de la page"
-		}
-	},
-	"loading": {
-		"en": "Loading",
-		"fr": "Chargement"
-	},
-	"dropdownList": {
-		"select": {
-			"en": "Select",
-			"fr": "Sélectionner"
-		}
-	},
-	"contactUs": {
-		"en": "Contact us",
-		"fr": "Contactez-nous"
-	},
 	"accessibilityLink": {
-		"text": {
-			"en": "Accessibility",
-			"fr": "Accessibilité"
-		},
 		"link": {
 			"en": "https://www.ontario.ca/page/accessibility",
 			"fr": "https://www.ontario.ca/fr/page/accessibilite"
-		}
-	},
-	"privacyLink": {
-		"text": {
-			"en": "Privacy",
-			"fr": "Confidentialité"
 		},
-		"link": {
-			"en": "https://www.ontario.ca/page/privacy-statement",
-			"fr": "https://www.ontario.ca/fr/page/declaration-concernant-la-protection-de-la-vie-privee"
-		}
-	},
-	"printerLink": {
 		"text": {
-			"en": "King's Printer for Ontario,",
-			"fr": "Imprimeur du Roi pour l’Ontario,"
-		},
-		"link": {
-			"en": "https://www.ontario.ca/page/copyright-information",
-			"fr": "https://www.ontario.ca/fr/page/droits-dauteur"
-		}
-	},
-	"languageToggle": {
-		"ariaLabel": {
-			"en": "Click to switch language to French",
-			"fr": "Cliquez pour changer de langue en anglais"
+			"en": "Accessibility",
+			"fr": "Accessibilité"
 		}
 	},
-	"stepIndicator": {
-		"back": {
-			"en": "Back",
-			"fr": "Retour"
-		},
-		"step": {
-			"en": "Step",
-			"fr": "Étape"
+	"accordion": {
+		"collapse": {
+			"en": "Collapse all",
+			"fr": "Réduire tout"
 		},
-		"of": {
-			"en": "of",
-			"fr": "sur"
+		"expand": {
+			"en": "Expand all",
+			"fr": "Agrandir tout"
 		},
-		"complete": {
-			"en": "complete",
-			"fr": "complet"
+		"expandCollapseAriaLabel": {
+			"en": "Expand or collapse the accordion",
+			"fr": "Agrandissez ou réduisez l'accordéon"
 		}
 	},
-	"header": {
-		"ontarioSearchURL": {
-			"en": "https://www.ontario.ca/search/search-results?query=",
-			"fr": "https://www.ontario.ca/fr/recherche/resultats-de-recherche/?query="
-		},
-		"logoLink": {
-			"en": "https://www.ontario.ca/page/government-ontario",
-			"fr": "https://www.ontario.ca/fr/page/gouvernement-de-lontario"
-		},
-		"logoAltText": {
-			"en": "Ontario.ca homepage",
-			"fr": "Page d’accueil Ontario.ca"
-		},
-		"clearSearchField": {
-			"en": "Clear field",
-			"fr": "Vider le champ"
-		},
-		"submit": {
-			"en": "Submit",
-			"fr": "Soumission"
-		},
-		"search": {
-			"en": "Search",
-			"fr": "Rechercher"
-		},
-		"serviceOntario": {
-			"en": "ServiceOntario",
-			"fr": "ServiceOntario"
-		},
-		"openMenu": {
-			"en": "Show navigation menu",
-			"fr": "Ouvrir le menu de navigation"
-		},
-		"closeMenu": {
-			"en": "Hide navigation menu",
-			"fr": "Fermer le menu de navigation"
-		},
-		"close": {
-			"en": "close",
-			"fr": "fermer"
+	"backToTop": {
+		"ariaLabel": {
+			"en": "Scroll back to the top",
+			"fr": "Retour en haut de la page"
 		},
-		"closeSearch": {
-			"en": "Close search bar",
-			"fr": "Fermer la barre de recherche"
+		"top": {
+			"en": "Top",
+			"fr": "Haut"
 		}
 	},
-	"input": {
-		"requiredFieldError": {
-			"en": "This is a required field.",
-			"fr": "Ce champ est obligatoire."
-		}
+	"contactUs": {
+		"en": "Contact us",
+		"fr": "Contactez-nous"
 	},
 	"dateInput": {
 		"caption": {
@@ -157,43 +57,23 @@
 			"fr": "Dates exactes"
 		},
 		"day": {
-			"label": {
-				"en": "Day",
-				"fr": "Jour"
-			},
 			"accessibility": {
 				"en": "4 digits",
 				"fr": "4 chiffres"
-			}
-		},
-		"month": {
-			"label": {
-				"en": "Month",
-				"fr": "Mois"
 			},
-			"accessibility": {
-				"en": "1 or 2 digits",
-				"fr": "1 ou 2 chiffres"
-			}
-		},
-		"year": {
 			"label": {
-				"en": "Year",
-				"fr": "Année"
-			},
-			"accessibility": {
-				"en": "1 or 2 digits",
-				"fr": "1 ou 2 chiffres"
+				"en": "Day",
+				"fr": "Jour"
 			}
 		},
 		"error": {
 			"en": {
 				"emptyDay": "Enter the day.",
-				"emptyMonth": "Enter the month.",
-				"emptyYear": "Enter the year.",
 				"emptyDayAndMonth": "Enter the month and day.",
 				"emptyDayAndYear": "Enter the year and day.",
+				"emptyMonth": "Enter the month.",
 				"emptyMonthAndYear": "Enter the year and month.",
+				"emptyYear": "Enter the year.",
 				"invalidDate": "Enter a valid date.",
 				"invalidDay": "Enter a valid day.",
 				"invalidMonth": "Enter a valid month.",
@@ -201,30 +81,160 @@
 			},
 			"fr": {
 				"emptyDay": "Saisissez le jour.",
-				"emptyMonth": "Saisissez le mois.",
-				"emptyYear": "Saisissez l’année.",
 				"emptyDayAndMonth": "Saisissez le mois et le jour.",
 				"emptyDayAndYear": "Saisissez l’année et le jour.",
+				"emptyMonth": "Saisissez le mois.",
 				"emptyMonthAndYear": "Saisissez l’année et le mois.",
+				"emptyYear": "Saisissez l’année.",
 				"invalidDate": "Saisissez une date valide.",
 				"invalidDay": "Saisissez un jour valide.",
 				"invalidMonth": "Saisissez un mois valide.",
 				"invalidYear": "Saisissez une année valide."
 			}
+		},
+		"month": {
+			"accessibility": {
+				"en": "1 or 2 digits",
+				"fr": "1 ou 2 chiffres"
+			},
+			"label": {
+				"en": "Month",
+				"fr": "Mois"
+			}
+		},
+		"year": {
+			"accessibility": {
+				"en": "1 or 2 digits",
+				"fr": "1 ou 2 chiffres"
+			},
+			"label": {
+				"en": "Year",
+				"fr": "Année"
+			}
 		}
 	},
-	"accordion": {
-		"expand": {
-			"en": "Expand all",
-			"fr": "Agrandir tout"
+	"dropdownList": {
+		"select": {
+			"en": "Select",
+			"fr": "Sélectionner"
+		}
+	},
+	"header": {
+		"clearSearchField": {
+			"en": "Clear field",
+			"fr": "Vider le champ"
 		},
-		"collapse": {
-			"en": "Collapse all",
-			"fr": "Réduire tout"
+		"close": {
+			"en": "close",
+			"fr": "fermer"
 		},
-		"expandCollapseAriaLabel": {
-			"en": "Expand or collapse the accordion",
-			"fr": "Agrandissez ou réduisez l'accordéon"
+		"closeMenu": {
+			"en": "Hide navigation menu",
+			"fr": "Fermer le menu de navigation"
+		},
+		"closeSearch": {
+			"en": "Close search bar",
+			"fr": "Fermer la barre de recherche"
+		},
+		"logoAltText": {
+			"en": "Ontario.ca homepage",
+			"fr": "Page d’accueil Ontario.ca"
+		},
+		"logoLink": {
+			"en": "https://www.ontario.ca/page/government-ontario",
+			"fr": "https://www.ontario.ca/fr/page/gouvernement-de-lontario"
+		},
+		"ontarioSearchURL": {
+			"en": "https://www.ontario.ca/search/search-results?query=",
+			"fr": "https://www.ontario.ca/fr/recherche/resultats-de-recherche/?query="
+		},
+		"openMenu": {
+			"en": "Show navigation menu",
+			"fr": "Ouvrir le menu de navigation"
+		},
+		"search": {
+			"en": "Search",
+			"fr": "Rechercher"
+		},
+		"serviceOntario": {
+			"en": "ServiceOntario",
+			"fr": "ServiceOntario"
+		},
+		"submit": {
+			"en": "Submit",
+			"fr": "Soumission"
+		}
+	},
+	"input": {
+		"requiredFieldError": {
+			"en": "This is a required field.",
+			"fr": "Ce champ est obligatoire."
+		}
+	},
+	"languageToggle": {
+		"ariaLabel": {
+			"en": "Click to switch the language to English",
+			"fr": "Cliquez pour changer la langue en français"
+		}
+	},
+	"loading": {
+		"en": "Loading",
+		"fr": "Chargement"
+	},
+	"optional": {
+		"en": "optional",
+		"fr": "facultative"
+	},
+	"printerLink": {
+		"link": {
+			"en": "https://www.ontario.ca/page/copyright-information",
+			"fr": "https://www.ontario.ca/fr/page/droits-dauteur"
+		},
+		"text": {
+			"en": "King's Printer for Ontario,",
+			"fr": "Imprimeur du Roi pour l’Ontario,"
+		}
+	},
+	"privacyLink": {
+		"link": {
+			"en": "https://www.ontario.ca/page/privacy-statement",
+			"fr": "https://www.ontario.ca/fr/page/declaration-concernant-la-protection-de-la-vie-privee"
+		},
+		"text": {
+			"en": "Privacy",
+			"fr": "Confidentialité"
+		}
+	},
+	"stepIndicator": {
+		"back": {
+			"en": "Back",
+			"fr": "Retour"
+		},
+		"complete": {
+			"en": "complete",
+			"fr": "complet"
+		},
+		"of": {
+			"en": "of",
+			"fr": "sur"
+		},
+		"step": {
+			"en": "Step",
+			"fr": "Étape"
+		}
+	},
+	"siteLanguage": {
+		"fullWord": {
+			"en": "English",
+			"fr": "Français"
+		},
+		"abbreviation": {
+			"en": "en",
+			"fr": "fr"
 		}
+	},
+	"required": {
+		"en": "required",
+		"fr": "obligatoire"
 	}
 }

package/src/utils/common/language-types.ts

@@ -1 +1,2 @@
-export type Language = 'en' | 'fr';
+export const supportedLanguages = ['en', 'fr'] as const;
+export type Language = (typeof supportedLanguages)[number];

package/src/utils/helper/utils-types.ts

@@ -0,0 +1,2 @@
+export const conjunctions = ['and', 'or'] as const;
+export type Conjunction = (typeof conjunctions)[number];

package/src/utils/helper/utils.ts

@@ -1,3 +1,5 @@
+import { Conjunction } from './utils-types';
+
 export function format(first: string | undefined, middle: string | undefined, last: string | undefined): string {
 	return (first || '') + (middle ? ` ${middle}` : '') + (last ? ` ${last}` : '');
 }
@@ -82,3 +84,31 @@ export function isEmpty(str: string | undefined | null): boolean {
 export function retrieveEnumKeys(enumObject: object): string[] {
 	return Object.keys(enumObject).filter(isNumber);
 }
+
+/**
+ * Prints an array as a comma delimited list, with the last element being preceded by a conjunction.
+ * As per ontario.ca content guidelines, there is no Oxford comma.
+ *
+ * @param {Array<any>} arr - The array that you wish to print.
+ * @param {Conjunction} conjunctionType - Whether you want the sentence to end with 'and value.' or 'or value.'
+ *
+ * @returns {string}
+ */
+export function printArray(arr: Array<any>, conjunctionType: Conjunction = 'and'): string {
+	return [...arr].reduce(
+		(text, value, i, array) => text + (i < array.length - 1 ? ', ' : ` ${conjunctionType} `) + value,
+	);
+}
+
+/**
+ * Grabs the HTML element of the page.
+ *
+ * More targetted than document.documentElement as the documentElement could
+ * in theory be any element that is the top level. e.g. <div> if the page is not
+ * set up to be semantically correct.
+ *
+ * @returns {HTMLElement}
+ */
+export function getRootHTMLElement(): HTMLElement {
+	return document.getElementsByTagName('html')[0];
+}