-
Notifications
You must be signed in to change notification settings - Fork 734
Add docs for t-z components #1648
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
"name": "Text", | ||
"category": "basic", | ||
"description": "A wrapper for Text component with extra functionality like modifiers support", | ||
"extends": ["Text"], | ||
"modifiers": ["margins", "color", "typography"], | ||
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/TextScreen.js", | ||
"images": [ | ||
"https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Text/Modifiers.png?raw=true, https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Text/Transformation.png?raw=true, https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Text/Highlights.png?raw=true" | ||
], | ||
"props": [ | ||
{"name": "color", "type": "string", "description": "Color of the text"}, | ||
{"name": "center", "type": "boolean", "description": "Whether to center the text (using textAlign)"}, | ||
{"name": "uppercase", "type": "boolean", "description": "Whether to change the text to uppercase"}, | ||
{"name": "highlightString", "type": "string | string[]", "description": "Substring to highlight"}, | ||
{"name": "highlightStyle", "type": "TextStyle", "description": "Custom highlight style for highlight string"}, | ||
{"name": "animated", "type": "boolean", "description": "Use Animated.Text as a container"} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"name": "TouchableOpacity", | ||
"category": "basic", | ||
"description": "A wrapper for TouchableOpacity component. Support onPress, throttling and activeBackgroundColor", | ||
"extends": ["TouchableOpacity"], | ||
"extendsLink": ["https://reactnative.dev/docs/touchableopacity"], | ||
"modifiers": ["margins", "paddings", "alignments", "background", "borderRadius"], | ||
"example": "https://github.com/wix/react-native-ui-lib/blob/master/src/components/touchableOpacity/index.tsx", | ||
"images": ["https://media.giphy.com/media/xULW8AMIgw7l31zjm8/giphy.gif"], | ||
"props": [ | ||
{"name": "backgroundColor", "type": "string", "description": "Background color for TouchableOpacity"}, | ||
{"name": "throttleTime", "type": "number", "description": "Throttle time in MS for onPress callback"}, | ||
{"name": "throttleOptions", "type": "{leading: boolean; trailing: boolean}", "description": "Throttle options"}, | ||
{ | ||
"name": "activeBackgroundColor", | ||
"type": "string", | ||
"description": "Apply background color on TouchableOpacity when active (press is on)" | ||
}, | ||
{ | ||
"name": "useNative", | ||
"type": "boolean", | ||
"description": "Should use an enhanced native implementation with extra features" | ||
}, | ||
{ | ||
"name": "customValue", | ||
"type": "any", | ||
"description": "Custom value of any type to pass on to TouchableOpacity and receive back in onPress callback" | ||
}, | ||
{"name": "style", "type": "ViewStyle", "description": "Custom style"}, | ||
{"name": "onPress", "type": "({customValue}) => void", "description": "On press callback"} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{ | ||
"name": "View", | ||
"category": "basic", | ||
"description": "An enhanced View component", | ||
"extends": ["View"], | ||
"extendsLink": ["https://reactnative.dev/docs/view"], | ||
"modifiers": ["margins", "paddings", "alignments", "background", "borderRadius"], | ||
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ViewScreen.js", | ||
"images": [], | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can be removed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I kept images array empty so it will remind us to add images to this component |
||
"props": [ | ||
{"name": "useSafeArea", "type": "boolean", "description": "If true, will render as SafeAreaView"}, | ||
{"name": "animated", "type": "boolean", "description": "Use Animate.View as a container"}, | ||
{ | ||
"name": "reanimated", | ||
"type": "boolean", | ||
"description": "Use Animate.View (from react-native-reanimated) as a container" | ||
}, | ||
{ | ||
"name": "inaccessible", | ||
"type": "boolean", | ||
"description": "Turn off accessibility for this view and its nested children" | ||
}, | ||
{"name": "renderDelay", "type": "number", "description": "Experimental: Pass time in ms to delay render"}, | ||
{"name": "backgroundColor", "type": "string", "description": "Set background color"}, | ||
{"name": "style", "type": "ViewStyle", "description": "Custom style"} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"name": "Wizard", | ||
"category": "layoutsAndTemplates", | ||
"description": "A wizard presents a series of steps in prescribed order. That the user needs to complete in order to accomplish a goal (e.g. purchase a product)", | ||
"note": "Use Wizard with nested Wizard.Step(s) to achieve the desired result.", | ||
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/WizardScreen.tsx", | ||
"images": [ | ||
"https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Wizard/Wizard.gif?raw=true", | ||
"https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Wizard/WizardPresets.png?raw=true" | ||
], | ||
"props": [ | ||
{"name": "activeIndex", "type": "number", "description": "The active step's index"}, | ||
{ | ||
"name": "activeConfig", | ||
"type": "WizardStepProps", | ||
"description": "The configuration of the active step (see Wizard.Step.propTypes)" | ||
}, | ||
{ | ||
"name": "onActiveIndexChanged", | ||
"type": "(index: number) => void", | ||
"description": "Callback that is called when the active step is changed (i.e. a step was clicked on). The new activeIndex will be the input of the callback" | ||
}, | ||
{"name": "containerStyle", "type": "ViewStyle", "description": "Add or override style of the container"}, | ||
{"name": "testID", "type": "string", "description": "The component test id"} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"name": "Wizard.Step", | ||
"category": "layoutsAndTemplates", | ||
"description": "A wizard presents a series of steps in prescribed order. That the user needs to complete in order to accomplish a goal (e.g. purchase a product)", | ||
"note": "Use Wizard with nested Wizard.Step(s) to achieve the desired result.", | ||
"example": "https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/WizardScreen.tsx", | ||
"images": [ | ||
"https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Wizard/Wizard.gif?raw=true", | ||
"https://github.com/wix/react-native-ui-lib/blob/master/demo/showcase/Wizard/WizardPresets.png?raw=true" | ||
], | ||
"props": [ | ||
{"name": "state", "type": "WizardStepStates", "description": "The state of the step (Wizard.States.X)"}, | ||
{"name": "label", "type": "string", "description": "The label of the item"}, | ||
{"name": "labelStyle", "type": "TextStyle", "description": "Additional styles for the label"}, | ||
{"name": "connectorStyle", "type": "ViewStyle", "description": "Additional styles for the connector"}, | ||
{"name": "color", "type": "string", "description": "Color of the step index (or of the icon, when provided)"}, | ||
{"name": "circleColor", "type": "string", "description": "Color of the circle"}, | ||
{"name": "circleSize", "type": "number", "description": "The step's circle size (diameter)"}, | ||
{"name": "circleBackgroundColor", "type": "string", "description": "Circle's background color"}, | ||
{"name": "icon", "type": "ImageProps", "description": "Icon to replace the (default) index"}, | ||
{ | ||
"name": "indexLabelStyle", | ||
"type": "TextStyle", | ||
"description": "Additional styles for the index's label (when icon is not provided)" | ||
}, | ||
{"name": "enabled", "type": "boolean", "description": "Whether the step should be enabled"}, | ||
{"name": "accessibilityInfo", "type": "string", "description": "Extra text to be read in accessibility mode"} | ||
] | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
consider adding
extendsLink
for react-native'sText