Skip to content

infra: create api.json files for components missing documentation #3627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Mar 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f83b9a0
infra: create api.json files for components missing documentation
devin-ai-integration[bot] Mar 17, 2025
2502b33
infra: remove TextFieldOld api.json as requested
devin-ai-integration[bot] Mar 17, 2025
052c620
infra: remove Inputs api.json as requested
devin-ai-integration[bot] Mar 17, 2025
f60f15d
infra: remove BaseInput api.json as requested
devin-ai-integration[bot] Mar 17, 2025
4b6fce2
infra: add api.json files for incubator components PanView and Expand…
devin-ai-integration[bot] Mar 17, 2025
3b289d9
infra: remove api.json for internal FadedScrollView component
devin-ai-integration[bot] Mar 20, 2025
d623f53
infra: remove api.json files for internal components
devin-ai-integration[bot] Mar 20, 2025
64f28ef
infra: remove duplicate Picker api.json file
devin-ai-integration[bot] Mar 20, 2025
340f445
infra: remove duplicate TabController api.json file
devin-ai-integration[bot] Mar 20, 2025
195708b
infra: update category to 'incubator' for incubator components
devin-ai-integration[bot] Mar 20, 2025
05e7bdf
infra: restore ScrollBar API JSON file with fixed snippet
devin-ai-integration[bot] Mar 20, 2025
af35d20
infra: add API JSON files for SharedTransition subcomponents and upda…
devin-ai-integration[bot] Mar 20, 2025
41aa57d
infra: update ScrollBar API JSON category and snippet
devin-ai-integration[bot] Mar 20, 2025
3acc440
infra: update ScrollBar API JSON snippet to use _.times function
devin-ai-integration[bot] Mar 20, 2025
f0ebcf5
infra: update ScrollBar API JSON category to layouts
devin-ai-integration[bot] Mar 20, 2025
2127344
infra: remove API JSON files for components that should not be exposed
devin-ai-integration[bot] Mar 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"name": "KeyboardAwareScrollView",
"category": "form",
"description": "A wrapper component which handles the ScrollView insets properly when the keyboard is shown and hides the content, scrolling content above the keybaord.",
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/KeyboardAwareScrollViewScreen.js",
"props": [
{
"name": "getTextInputRefs",
"type": "function",
"description": "Function that returns an array of TextInput refs"
},
{
"name": "onScroll",
"type": "function",
"description": "Callback for scroll events"
},
{
"name": "startScrolledToBottom",
"type": "boolean",
"description": "Whether to start scrolled to bottom"
},
{
"name": "scrollToBottomOnKBShow",
"type": "boolean",
"description": "Whether to scroll to bottom when keyboard shows"
},
{
"name": "scrollToInputAdditionalOffset",
"type": "number",
"description": "Additional offset when scrolling to input"
}
],
"snippet": [
"<KeyboardAwareScrollView>",
" <View>",
" <TextField placeholder=\"Input with scrolling\" />",
" </View>",
"</KeyboardAwareScrollView>"
]
}
54 changes: 54 additions & 0 deletions src/components/modal/modal.api.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"name": "Modal",
"category": "overlays",
"description": "Component that present content on top of the invoking screen",
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx",
"props": [
{
"name": "enableModalBlur",
"type": "boolean",
"description": "Blurs the modal background when transparent (iOS only)"
},
{
"name": "blurView",
"type": "JSX.Element",
"description": "A custom view to use as a BlueView instead of the default one"
},
{
"name": "onBackgroundPress",
"type": "function",
"description": "Allow dismissing a modal when clicking on its background"
},
{
"name": "overlayBackgroundColor",
"type": "string",
"description": "The background color of the overlay"
},
{
"name": "useGestureHandlerRootView",
"type": "boolean",
"description": "Should add a GestureHandlerRootView"
},
{
"name": "useKeyboardAvoidingView",
"type": "boolean",
"description": "Should add a KeyboardAvoidingView (iOS only)"
},
{
"name": "keyboardAvoidingViewProps",
"type": "object",
"description": "Send additional props to the KeyboardAvoidingView (iOS only)"
}
],
"snippet": [
"<Modal",
" visible={visible}",
" onBackgroundPress={() => setVisible(false)}",
" overlayBackgroundColor=\"rgba(0, 0, 0, 0.7)\"",
">",
" <View>",
" <Text>Modal Content</Text>",
" </View>",
"</Modal>"
]
}