gt-react 10.6.6-alpha.4 → 10.6.6

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # gt-react
 
+## 10.6.6
+
+### Patch Changes
+
+- Updated dependencies [[`5208937`](https://github.com/generaltranslation/gt/commit/520893719480b40774ccd749fe73727cf490f46c)]:
+  - generaltranslation@7.7.0
+  - @generaltranslation/supported-locales@2.0.16
+
 ## 10.6.5
 
 ### Patch Changes

package/dist/branches/Branch.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
+ * It allows for flexible content switching based on the `branch` prop and an object of possible branches (`...branches`).
+ * If the specified `branch` is present in the `branches` object, it renders the content of that branch.
+ * If the `branch` is not found, it renders the provided `children` as fallback content.
+ *
+ * @example
+ * ```jsx
+ * <Branch
+ *  branch="summary"
+ * summary={<p>This is a summary</p>}
+ * details={<p>Details here</p>}
+ * >
+ *   <p>Fallback content</p>
+ * </Branch>
+ * ```
+ * If the `branch` prop is set to `"summary"`, it will render `<p>This is a summary</p>`. If the `branch` is not set or does not match any keys in the branches object, it renders the fallback content `<p>Fallback content</p>`.
+ *
+ * @param {any} [children] - Fallback content to render if no matching branch is found.
+ * @param {any} [name="branch"] - Optional name for the component, used for metadata or tracking purposes.
+ * @param {string} [branch] - The name of the branch to render. The component looks for this key in the `...branches` object.
+ * @param {...{[key: string]: any}} [branches] - A spread object containing possible branches as keys and their corresponding content as values.
+ * @returns {React.JSX.Element} The rendered branch or fallback content.
+ */
+declare function Branch({ children, branch, ...branches }: {
+    children?: any;
+    branch?: string | number | boolean;
+    [key: string]: any;
+}): React.JSX.Element;
+declare namespace Branch {
+    var _gtt: string;
+}
+export default Branch;
+//# sourceMappingURL=Branch.d.ts.map

package/dist/branches/Branch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Branch.d.ts","sourceRoot":"","sources":["../../src/branches/Branch.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iBAAS,MAAM,CAAC,EACd,QAAQ,EACR,MAAM,EACN,GAAG,QAAQ,EACZ,EAAE;IACD,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAOpB;kBAfQ,MAAM;;;AAkBf,eAAe,MAAM,CAAC"}

package/dist/branches/plurals/Plural.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The `<Plural>` component dynamically renders content based on the plural form of the given number (`n`).
+ * It determines which content to display by matching the value of `n` to the appropriate pluralization branch,
+ * based on the current locale or a default locale. If no matching plural branch is found, the component renders
+ * the fallback `children` content.
+ *
+ * @example
+ * ```jsx
+ * <Plural
+ *  n={1}
+ *  one="There is 1 item"
+ *  other="There are {n} items"
+ * />
+ * ```
+ * In this example, if `n` is 1, it renders `"There is 1 item"`. If `n` is a different number, it renders
+ * `"There are {n} items"`.
+ *
+ * @param {any} [children] - Fallback content to render if no matching plural branch is found.
+ * @param {number} [n] - The number used to determine the plural form. This is required for pluralization to work.
+ * @param {string} [locales] - Optional parameter, the locale to use for pluralization format. If not provided and wrapped
+ *  in <GTProvider> will automatically populate this value as user's current locale. If not provided and not wrapped in
+ *  <GTProvider>, will use the library default locale (en-US).
+ * @param {...{[key: string]: any}} [branches] - A spread object containing possible plural branches, typically including `one` for singular
+ * and `other` for plural forms, but it may vary depending on the locale.
+ * @returns {React.JSX.Element} The rendered content corresponding to the plural form of `n`, or the fallback content.
+ * @throws {Error} If `n` is not provided or not a valid number.
+ */
+declare function Plural({ children, n, locales, ...branches }: {
+    children?: React.ReactNode;
+    n?: number;
+    locales?: string;
+    [key: string]: any;
+}): React.JSX.Element;
+declare namespace Plural {
+    var _gtt: string;
+}
+export default Plural;
+//# sourceMappingURL=Plural.d.ts.map

package/dist/branches/plurals/Plural.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plural.d.ts","sourceRoot":"","sources":["../../../src/branches/plurals/Plural.tsx"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,iBAAS,MAAM,CAAC,EACd,QAAQ,EACR,CAAC,EACD,OAAO,EACP,GAAG,QAAQ,EACZ,EAAE;IACD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAcpB;kBAxBQ,MAAM;;;AA4Bf,eAAe,MAAM,CAAC"}

package/dist/branches/plurals/getPluralBranch.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Main function to get the appropriate branch based on the provided number and branches.
+ *
+ * @param {number} n - The number to determine the branch for.
+ * @param {any} branches - The object containing possible branches.
+ * @returns {any} The determined branch.
+ */
+export default function getPluralBranch(n: number, locales: string[], branches: Record<string, any>): any;
+//# sourceMappingURL=getPluralBranch.d.ts.map

package/dist/branches/plurals/getPluralBranch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPluralBranch.d.ts","sourceRoot":"","sources":["../../../src/branches/plurals/getPluralBranch.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CACrC,CAAC,EAAE,MAAM,EACT,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OAQ9B"}