Skip to content

Commit d3db562

Browse files
authored
Add docs for components m-o (#1643)
* Add docs for components m-o * Fix
1 parent 511639d commit d3db562

File tree

4 files changed

+129
-0
lines changed

4 files changed

+129
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"name": "MaskedInput",
3+
"category": "form",
4+
"description": "Mask Input to create custom looking inputs with custom formats",
5+
"extends": ["TextField"],
6+
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/MaskedInputScreen.js",
7+
"images": [
8+
"https://camo.githubusercontent.com/61eedb65e968845d5eac713dcd21a69691571fb1/68747470733a2f2f6d656469612e67697068792e636f6d2f6d656469612f4b5a5a7446666f486f454b334b2f67697068792e676966"
9+
],
10+
"props": [
11+
{
12+
"name": "renderMaskedText",
13+
"type": "React.ReactElement",
14+
"required": true,
15+
"description": "callback for rendering the custom input out of the value returns from the actual input"
16+
},
17+
{
18+
"name": "containerStyle",
19+
"type": "ViewStyle",
20+
"description": "container style for the masked input container"
21+
}
22+
]
23+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "Modal",
3+
"category": "layoutsAndTemplates",
4+
"description": "Component that present content on top of the invoking screen",
5+
"extends": ["Modal"],
6+
"extendsLink": ["https://reactnative.dev/docs/modal"],
7+
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx",
8+
"images": ["https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif"],
9+
"props": [
10+
{
11+
"name": "enableModalBlur",
12+
"type": "boolean",
13+
"description": "Blurs the modal background when transparent (iOS only)"
14+
},
15+
{
16+
"name": "blurView",
17+
"type": "JSX.Element",
18+
"description": "A custom view to use as a BlueView instead of the default one"
19+
},
20+
{
21+
"name": "onBackgroundPress",
22+
"type": "(event: GestureResponderEvent) => void",
23+
"description": "allow dismissing a modal when clicking on its background"
24+
},
25+
{"name": "overlayBackgroundColor", "type": "string", "description": "The background color of the overlay"},
26+
{"name": "testID", "type": "string", "description": "The modal's end-to-end test identifier"},
27+
{
28+
"name": "accessibilityLabel",
29+
"type": "string",
30+
"description": "Overrides the text that's read by the screen reader when the user interacts with the element.\\By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space."
31+
},
32+
{
33+
"name": "useGestureHandlerRootView",
34+
"type": "boolean",
35+
"description": "Should add a GestureHandlerRootView (Android only)"
36+
}
37+
]
38+
}
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"name": "Modal.TopBar",
3+
"category": "layoutsAndTemplates",
4+
"description": "Modal.TopBar, inner component for configuring the Modal component's title, buttons and statusBar",
5+
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ModalScreen.tsx",
6+
"images": ["https://media.giphy.com/media/3oFzmfSX8KgvctI4Ks/giphy.gif"],
7+
"props": [
8+
{"name": "title", "type": "string", "description": "Title to display in the center of the top bar"},
9+
{"name": "titleStyle", "type": "TextStyle", "description": "Title custom style"},
10+
{
11+
"name": "doneButtonProps",
12+
"type": "ButtonProps",
13+
"description": "Done action props",
14+
"default": "{color: Colors.primary}"
15+
},
16+
{"name": "doneLabel", "type": "string", "description": "Done action label", "default": "Save"},
17+
{"name": "doneIcon", "type": "ImageSource", "description": "Done action icon"},
18+
{"name": "onDone", "type": "(props?: any) => void", "description": "Done action callback"},
19+
{
20+
"name": "cancelButtonProps",
21+
"type": "ButtonProps",
22+
"description": "Cancel action props",
23+
"default": "{color: Colors.primary}"
24+
},
25+
{"name": "cancelLabel", "type": "string", "description": "Cancel action label"},
26+
{
27+
"name": "cancelIcon",
28+
"type": "ImageSource",
29+
"description": "Cancel action icon",
30+
"default": "Assets.icons.x"
31+
},
32+
{"name": "onCancel", "type": "(props?: any) => void", "description": "Cancel action callback"},
33+
{
34+
"name": "includeStatusBar",
35+
"type": "boolean",
36+
"description": "Whether to include status bar or not (height calculations)",
37+
"default": "Constants.isIOS"
38+
},
39+
{"name": "containerStyle", "type": "ViewStyle", "description": "Style for the TopBar container"}
40+
]
41+
}
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "Overlay",
3+
"category": "basic",
4+
"description": "Overlay view with types",
5+
"extends": ["Image"],
6+
"extendsLink": ["https://reactnative.dev/docs/image"],
7+
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/OverlaysScreen.tsx",
8+
"props": [
9+
{
10+
"name": "type",
11+
"type": "vertical | top | bottom | solid (OverlayTypeType)",
12+
"description": "The type of overlay to set on top of the image"
13+
},
14+
{
15+
"name": "intensity",
16+
"type": "low | medium | high",
17+
"description": "The intensity of the gradient.",
18+
"default": "OverlayIntensityType.LOW"
19+
},
20+
{"name": "color", "type": "string", "description": "The overlay color"},
21+
{
22+
"name": "customContent",
23+
"type": "JSX.Element",
24+
"description": "Custom overlay content to be rendered on top of the image"
25+
}
26+
]
27+
}

0 commit comments

Comments
 (0)