@granite-js/style-utils 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# @granite-js/style-utils
+
+## 0.0.3
+
+### Patch Changes
+
+- ed4d356: changeset
+
+## 0.0.2
+
+### Patch Changes
+
+- 0ae09b7: deploy guide
+- 0ae09b7: type fix
+- 0ae09b7: guide
+- 0ae09b7: fix comment
+- 0ae09b7: showcase
+- 0ae09b7: refactor interface names
+- 0ae09b7: CanGoBackGuard 수정, typecheck fix, lint fix
+- 0ae09b7: counter
+- 0ae09b7: eslint up
+
+## 0.0.1
+
+### Patch Changes
+
+- f47ca39: first release

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Viva Republica, Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,24 @@
+# @granite-js/style-utils
+
+A package for Style utilities
+
+## License
+
+This software is licensed under the [Apache 2 license](LICENSE), quoted below.
+
+```
+Copyright 2025 Viva Republica, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+```

package/dist/box-spacing.d.ts

@@ -0,0 +1,220 @@
+import type { ViewStyle } from 'react-native';
+interface BoxSpacingOptionObject {
+    x?: never;
+    y?: never;
+    top?: never;
+    bottom?: never;
+    left?: never;
+    right?: never;
+}
+type BoxSpacingOptionObjectCase<Option extends keyof BoxSpacingOptionObject> = {
+    [O in Option]?: number;
+} & {
+    [P in Exclude<keyof BoxSpacingOptionObject, Option>]?: never;
+};
+export type BoxSpacingOption = BoxSpacingOptionObjectCase<'x' | 'y'> | BoxSpacingOptionObjectCase<'x' | 'top' | 'bottom'> | BoxSpacingOptionObjectCase<'y' | 'left' | 'right'> | BoxSpacingOptionObjectCase<'top' | 'right' | 'bottom' | 'left'> | number;
+export declare function spacing(styleProperty: string, option: BoxSpacingOption): ViewStyle;
+export interface BoxSpacingPresets {
+    readonly x: (value: number) => ViewStyle;
+    readonly x4: ViewStyle;
+    readonly x8: ViewStyle;
+    readonly x12: ViewStyle;
+    readonly x16: ViewStyle;
+    readonly x24: ViewStyle;
+    readonly x32: ViewStyle;
+    readonly y: (value: number) => ViewStyle;
+    readonly y4: ViewStyle;
+    readonly y8: ViewStyle;
+    readonly y12: ViewStyle;
+    readonly y16: ViewStyle;
+    readonly y24: ViewStyle;
+    readonly y32: ViewStyle;
+    readonly top: (value: number) => ViewStyle;
+    readonly top4: ViewStyle;
+    readonly top8: ViewStyle;
+    readonly top12: ViewStyle;
+    readonly top16: ViewStyle;
+    readonly top24: ViewStyle;
+    readonly top32: ViewStyle;
+    readonly right: (value: number) => ViewStyle;
+    readonly right4: ViewStyle;
+    readonly right8: ViewStyle;
+    readonly right12: ViewStyle;
+    readonly right16: ViewStyle;
+    readonly right24: ViewStyle;
+    readonly right32: ViewStyle;
+    readonly bottom: (value: number) => ViewStyle;
+    readonly bottom4: ViewStyle;
+    readonly bottom8: ViewStyle;
+    readonly bottom12: ViewStyle;
+    readonly bottom16: ViewStyle;
+    readonly bottom24: ViewStyle;
+    readonly bottom32: ViewStyle;
+    readonly left: (value: number) => ViewStyle;
+    readonly left4: ViewStyle;
+    readonly left8: ViewStyle;
+    readonly left12: ViewStyle;
+    readonly left16: ViewStyle;
+    readonly left24: ViewStyle;
+    readonly left32: ViewStyle;
+}
+export interface BoxSpacing extends BoxSpacingPresets {
+    (option: BoxSpacingOption): ViewStyle;
+}
+/**
+ * @public
+ * @category UI
+ * @name padding
+ * @description
+ * The `padding` function sets the inner spacing of a component to create appropriate spacing between content and boundaries. You can specify horizontal (x), vertical (y), and individual direction (top, right, bottom, left) spacing using numbers.
+ * You can apply the same value to all directions by entering a number, or set individual values for each direction. There are also presets for commonly used values for easy application.
+ *
+ * @param {BoxSpacingOption} option - The option value to specify inner spacing. If you enter a number, it applies the same value to all directions,
+ * or you can set individual values for each direction.
+ * @property {(value: number) => ViewStyle} x - Returns a style object that sets the inner spacing of the component's horizontal direction (left and right) by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} x4 - A style object that applies 4px inner spacing in the horizontal direction
+ * @property {ViewStyle} x8 - A style object that applies 8px inner spacing in the horizontal direction
+ * @property {ViewStyle} x12 - A style object that applies 12px inner spacing in the horizontal direction
+ * @property {ViewStyle} x16 - A style object that applies 16px inner spacing in the horizontal direction
+ * @property {ViewStyle} x24 - A style object that applies 24px inner spacing in the horizontal direction
+ * @property {ViewStyle} x32 - A style object that applies 32px inner spacing in the horizontal direction
+ * @property {(value: number) => ViewStyle} y - Returns a style object that sets the inner spacing of the component's vertical direction (top and bottom) by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} y4 - A style object that applies 4px inner spacing in the vertical direction
+ * @property {ViewStyle} y8 - A style object that applies 8px inner spacing in the vertical direction
+ * @property {ViewStyle} y12 - A style object that applies 12px inner spacing in the vertical direction
+ * @property {ViewStyle} y16 - A style object that applies 16px inner spacing in the vertical direction
+ * @property {ViewStyle} y24 - A style object that applies 24px inner spacing in the vertical direction
+ * @property {ViewStyle} y32 - A style object that applies 32px inner spacing in the vertical direction
+ * @property {(value: number) => ViewStyle} top - Returns a style object that sets the inner spacing of the component's top direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} top4 - A style object that applies 4px inner spacing to the top
+ * @property {ViewStyle} top8 - A style object that applies 8px inner spacing to the top
+ * @property {ViewStyle} top12 - A style object that applies 12px inner spacing to the top
+ * @property {ViewStyle} top16 - A style object that applies 16px inner spacing to the top
+ * @property {ViewStyle} top24 - A style object that applies 24px inner spacing to the top
+ * @property {ViewStyle} top32 - A style object that applies 32px inner spacing to the top
+ * @property {(value: number) => ViewStyle} right - Returns a style object that sets the inner spacing of the component's right direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} right4 - A style object that applies 4px inner spacing to the right
+ * @property {ViewStyle} right8 - A style object that applies 8px inner spacing to the right
+ * @property {ViewStyle} right12 - A style object that applies 12px inner spacing to the right
+ * @property {ViewStyle} right16 - A style object that applies 16px inner spacing to the right
+ * @property {ViewStyle} right24 - A style object that applies 24px inner spacing to the right
+ * @property {ViewStyle} right32 - A style object that applies 32px inner spacing to the right
+ * @property {(value: number) => ViewStyle} bottom - Returns a style object that sets the inner spacing of the component's bottom direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} bottom4 - A style object that applies 4px inner spacing to the bottom
+ * @property {ViewStyle} bottom8 - A style object that applies 8px inner spacing to the bottom
+ * @property {ViewStyle} bottom12 - A style object that applies 12px inner spacing to the bottom
+ * @property {ViewStyle} bottom16 - A style object that applies 16px inner spacing to the bottom
+ * @property {ViewStyle} bottom24 - A style object that applies 24px inner spacing to the bottom
+ * @property {ViewStyle} bottom32 - A style object that applies 32px inner spacing to the bottom
+ * @property {(value: number) => ViewStyle} left - Returns a style object that sets the inner spacing of the component's left direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} left4 - A style object that applies 4px inner spacing to the left
+ * @property {ViewStyle} left8 - A style object that applies 8px inner spacing to the left
+ * @property {ViewStyle} left12 - A style object that applies 12px inner spacing to the left
+ * @property {ViewStyle} left16 - A style object that applies 16px inner spacing to the left
+ * @property {ViewStyle} left24 - A style object that applies 24px inner spacing to the left
+ * @property {ViewStyle} left32 - A style object that applies 32px inner spacing to the left
+ *
+ * @example
+ * ## Example of applying 8px inner spacing in horizontal and vertical directions, and 100px spacing in the bottom direction
+ *
+ * ```tsx
+ * import { padding } from '@granite-js/react-native';
+ * import { View } from 'react-native';
+ *
+ * function Component() {
+ *   return (
+ *     <View>
+ *       <View style={padding.x8}>
+ *         <Text>Has horizontal spacing</Text>
+ *       </View>
+ *       <View style={padding.y8}>
+ *         <Text>Has vertical spacing</Text>
+ *       </View>
+ *       <View style={padding.bottom(100)}>
+ *         <Text>Has 100px spacing at the bottom</Text>
+ *       </View>
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+export declare const padding: BoxSpacing;
+/**
+ * @public
+ * @category UI
+ * @name margin
+ * @description
+ * The `margin` function sets the outer spacing of a component to create appropriate spacing between components. You can specify horizontal (x), vertical (y), and individual direction (top, right, bottom, left) spacing using numbers.
+ * You can apply the same value to all directions by entering a number, or set individual values for each direction. There are also presets for commonly used values for easy application.
+ *
+ * @param {BoxSpacingOption} option - The option value to specify outer spacing. If you enter a number, it applies the same value to all directions,
+ * or you can set individual values for each direction.
+ * @property {(value: number) => ViewStyle} x - Returns a style object that sets the outer spacing of the component's horizontal direction (left and right) by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} x4 - A style object that applies 4px outer spacing in the horizontal direction
+ * @property {ViewStyle} x8 - A style object that applies 8px outer spacing in the horizontal direction
+ * @property {ViewStyle} x12 - A style object that applies 12px outer spacing in the horizontal direction
+ * @property {ViewStyle} x16 - A style object that applies 16px outer spacing in the horizontal direction
+ * @property {ViewStyle} x24 - A style object that applies 24px outer spacing in the horizontal direction
+ * @property {ViewStyle} x32 - A style object that applies 32px outer spacing in the horizontal direction
+ * @property {(value: number) => ViewStyle} y - Returns a style object that sets the outer spacing of the component's vertical direction (top and bottom) by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} y4 - A style object that applies 4px outer spacing in the vertical direction
+ * @property {ViewStyle} y8 - A style object that applies 8px outer spacing in the vertical direction
+ * @property {ViewStyle} y12 - A style object that applies 12px outer spacing in the vertical direction
+ * @property {ViewStyle} y16 - A style object that applies 16px outer spacing in the vertical direction
+ * @property {ViewStyle} y24 - A style object that applies 24px outer spacing in the vertical direction
+ * @property {ViewStyle} y32 - A style object that applies 32px outer spacing in the vertical direction
+ * @property {(value: number) => ViewStyle} top - Returns a style object that sets the outer spacing of the component's top direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} top4 - A style object that applies 4px outer spacing to the top
+ * @property {ViewStyle} top8 - A style object that applies 8px outer spacing to the top
+ * @property {ViewStyle} top12 - A style object that applies 12px outer spacing to the top
+ * @property {ViewStyle} top16 - A style object that applies 16px outer spacing to the top
+ * @property {ViewStyle} top24 - A style object that applies 24px outer spacing to the top
+ * @property {ViewStyle} top32 - A style object that applies 32px outer spacing to the top
+ * @property {(value: number) => ViewStyle} right - Returns a style object that sets the outer spacing of the component's right direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} right4 - A style object that applies 4px outer spacing to the right
+ * @property {ViewStyle} right8 - A style object that applies 8px outer spacing to the right
+ * @property {ViewStyle} right12 - A style object that applies 12px outer spacing to the right
+ * @property {ViewStyle} right16 - A style object that applies 16px outer spacing to the right
+ * @property {ViewStyle} right24 - A style object that applies 24px outer spacing to the right
+ * @property {ViewStyle} right32 - A style object that applies 32px outer spacing to the right
+ * @property {(value: number) => ViewStyle} bottom - Returns a style object that sets the outer spacing of the component's bottom direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} bottom4 - A style object that applies 4px outer spacing to the bottom
+ * @property {ViewStyle} bottom8 - A style object that applies 8px outer spacing to the bottom
+ * @property {ViewStyle} bottom12 - A style object that applies 12px outer spacing to the bottom
+ * @property {ViewStyle} bottom16 - A style object that applies 16px outer spacing to the bottom
+ * @property {ViewStyle} bottom24 - A style object that applies 24px outer spacing to the bottom
+ * @property {ViewStyle} bottom32 - A style object that applies 32px outer spacing to the bottom
+ * @property {(value: number) => ViewStyle} left - Returns a style object that sets the outer spacing of the component's left direction by the input number. The returned object is passed to the component's `style` property to apply the spacing.
+ * @property {ViewStyle} left4 - A style object that applies 4px outer spacing to the left
+ * @property {ViewStyle} left8 - A style object that applies 8px outer spacing to the left
+ * @property {ViewStyle} left12 - A style object that applies 12px outer spacing to the left
+ * @property {ViewStyle} left16 - A style object that applies 16px outer spacing to the left
+ * @property {ViewStyle} left24 - A style object that applies 24px outer spacing to the left
+ * @property {ViewStyle} left32 - A style object that applies 32px outer spacing to the left
+ *
+ * @example
+ * ## Example of applying 8px outer spacing in horizontal and vertical directions, and 100px spacing in the bottom direction
+ *
+ * ```tsx
+ * import { margin } from '@granite-js/react-native';
+ * import { View } from 'react-native';
+ *
+ * function Component() {
+ *   return (
+ *     <View>
+ *       <View style={margin.x8}>
+ *         <Text>Has horizontal spacing</Text>
+ *       </View>
+ *       <View style={margin.y8}>
+ *         <Text>Has vertical spacing</Text>
+ *       </View>
+ *       <View style={margin.bottom(100)}>
+ *         <Text>Has 100px spacing at the bottom</Text>
+ *       </View>
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+export declare const margin: BoxSpacing;
+export {};

package/dist/children.d.ts

@@ -0,0 +1,53 @@
+import { type ReactNode } from 'react';
+/**
+ * @category Constants
+ * @name Children
+ * @description
+ * `Children` provides various components for controlling layouts related to child elements.
+ *
+ * @property {ChildrenGap} Gap - `Children.Gap` is a component used to add a specified component (gap) between multiple child elements when rendering.
+ */
+export declare const Children: {
+    /**
+     * @name Children.Gap
+     * @description Renders a gap component between ReactNode children.
+     */
+    Gap: typeof ChildrenGap;
+};
+interface ChildrenGapProps {
+    children: ReactNode;
+    gap: ReactNode;
+}
+/**
+ * @category Components
+ * @name ChildrenGap
+ * @description
+ * `Children.Gap` is a useful component for maintaining consistent layouts by adding spacing (gap) between multiple child elements.
+ * Using this component allows you to apply consistent spacing between child elements, resulting in a cleaner and more consistent UI design.
+ *
+ * @param {object} props - The `props` object passed to the component.
+ * @param {ReactNode} props.children - The child components to be rendered.
+ * @param {ReactNode} props.gap - The component to be placed between child elements. `gap` must be a valid React component.
+ *
+ * @throws {Error} An error occurs when `gap` is not a valid React component. `gap` must use `React.Element`.
+ *
+ * @example
+ * ## When you want to add 16px spacing between child elements
+ *
+ * ```tsx
+ * import { Children, Spacing } from '@granite-js/react-native';
+ * import { Text } from 'react-native';
+ *
+ * function Component() {
+ *   return (
+ *     <Children.Gap gap={<Spacing size={16} />}>
+ *       <Text>First</Text>
+ *       <Text>Second</Text>
+ *       <Text>Third</Text>
+ *     </Children.Gap>
+ *   );
+ * }
+ * ```
+ */
+declare function ChildrenGap({ children, gap }: ChildrenGapProps): import("react/jsx-runtime").JSX.Element;
+export {};