Skip to content

Commit 460c570

Browse files
committed
docs: document standalone components and SheetPicker in README
1 parent 4be8265 commit 460c570

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ export const BasicFormExample: FunctionComponent = () => {
135135

136136
Below is a list of components currently supported by `@mgcrea/react-native-swiftui`. These components leverage SwiftUI's native iOS capabilities while being controlled via React Native's JSX syntax.
137137

138+
### SwiftUI Tree Components
139+
140+
These components are used within the `<SwiftUI>` tree and accessed via `SwiftUI.*`:
141+
138142
| Component | Description | Key Props | Notes |
139143
| ------------ | ------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
140144
| `Button` | A clickable button with customizable styles | `title`, `buttonStyle`, `disabled`, `style`, `onPress` | Supports styles like `default`, `plain`, `bordered`, etc. |
@@ -156,6 +160,16 @@ Below is a list of components currently supported by `@mgcrea/react-native-swift
156160
| `VStack` | Vertical stack layout | `alignment`, `spacing`, `style`, Children | Alignments: `leading`, `center`, `trailing` |
157161
| `ZStack` | Overlapping stack layout | `alignment`, `style`, Children | Alignments: `topLeading`, `center`, `bottomTrailing`, etc. |
158162

163+
### Standalone Native Components
164+
165+
These components are standalone native views that can be used anywhere in your React Native app:
166+
167+
| Component | Description | Key Props | Notes |
168+
| --------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
169+
| `SwiftUIPicker` | A native picker modal with search functionality | `isPresented`, `title`, `searchPlaceholder`, `options`, `selectedValue`, `autoDismiss`, `onSelect` | Full-screen native picker with search and categorization support |
170+
| `SwiftUISheet` | A native modal sheet presentation | `isPresented`, `detents`, `onDismiss`, Children | Standalone sheet that can be used outside of SwiftUI tree |
171+
| `SwiftUISheetPicker` | A native picker presented as a bottom sheet | `isPresented`, `title`, `searchPlaceholder`, `options`, `selectedValue`, `autoDismiss`, `onSelect` | Combines sheet presentation with picker functionality for a native iOS experience |
172+
159173
## Contribute
160174

161175
We welcome contributions! If you have ideas for new components, optimizations, or bug fixes, please fork the repository and submit a pull request. We also encourage you to open issues for any bugs or feature requests.

0 commit comments

Comments
 (0)