feat(react-dictionary): default to more lenient types

codedazur · Sep 28, 2023 · 4e970b1 · 4e970b1
1 parent 3cfb400
commit 4e970b1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 17 deletions.
diff --git a/.changeset/mighty-crabs-smoke.md b/.changeset/mighty-crabs-smoke.md
@@ -0,0 +1,5 @@
+---
+"@codedazur/react-dictionary": minor
+---
+
+default to more lenient typings
diff --git a/packages/react-dictionary/components/DictionaryProvider.tsx b/packages/react-dictionary/components/DictionaryProvider.tsx
@@ -13,7 +13,7 @@ export interface DictionaryProviderProps {
 }
 
 export const DictionaryProvider: FunctionComponent<DictionaryProviderProps> = ({
-  locale = Locale.en_US,
+  locale = null,
   dictionaries,
   children,
 }) => {

diff --git a/packages/react-dictionary/contexts/dictionaryContext.ts b/packages/react-dictionary/contexts/dictionaryContext.ts
@@ -12,35 +12,24 @@ export type Dictionary = ReadonlyMap<DictionaryKey, string>;
  * import "@codedazur/react-dictionary";
  *
  * declare module "@codedazur/react-dictionary" {
- *   export enum DictionaryKey {
- *     "foo",
- *     "bar",
- *     "baz",
- *   }
+ *   export type DictionaryKey = "foo" | "bar" | "baz";
  * }
  */
-export enum DictionaryKey {}
+export type DictionaryKey = string;
 
 /**
- * This enum can be overridden using module augmentation.
+ * This type can be overridden using module augmentation.
  *
  * @example
  * // dictionary.d.ts
  *
  * import "@codedazur/react-dictionary";
  *
  * declare module "@codedazur/react-dictionary" {
- *   export enum Locale {
- *     en_US = "en_US",
- *     en_GB = "en_GB",
- *   }
+ *   export type Locale = "en_US" | "en_GB";
  * }
  */
-export enum Locale {
-  en_US = "en_US",
-}
-
-export const DefaultLocale = Locale.en_US;
+export type Locale = string;
 
 export interface DictionaryContext {
   locale: Locale | null;