-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ead8cf3
commit b72bcba
Showing
21 changed files
with
667 additions
and
10 deletions.
There are no files selected for viewing
This file contains 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,20 @@ | ||
# ActivityIndicator | ||
|
||
API documentation for the React Native ActivityIndicator component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { ActivityIndicator } from "@react-native-material/core"; | ||
// or | ||
import ActivityIndicator from "@react-native-material/core/ActivityIndicator"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface ActivityIndicatorProps extends NativeActivityIndicatorProps { | ||
color?: PaletteColor; | ||
} | ||
|
||
``` |
This file contains 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,60 @@ | ||
# Appbar | ||
|
||
API documentation for the React Native Appbar component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Appbar } from "@react-native-material/core"; | ||
// or | ||
import Appbar from "@react-native-material/core/Appbar"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface AppbarProps extends SurfaceProps { | ||
title?: string | React.ReactElement; | ||
|
||
subtitle?: string | React.ReactElement; | ||
|
||
variant?: "top" | "bottom"; | ||
|
||
color?: PaletteColor; | ||
|
||
tintColor?: PaletteColor; | ||
|
||
enableColorOnDark?: boolean; | ||
|
||
transparent?: boolean; | ||
|
||
centerTitle?: boolean; | ||
|
||
leading?: | ||
| React.ReactElement | ||
| React.ReactElement[] | ||
| ((props: { color: string; size: number }) => React.ReactElement | React.ReactElement[] | null) | ||
| null; | ||
|
||
trailing?: | ||
| React.ReactElement | ||
| React.ReactElement[] | ||
| ((props: { color: string; size: number }) => React.ReactElement | React.ReactElement[] | null) | ||
| null; | ||
|
||
contentContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
titleContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
titleStyle?: StyleProp<TextStyle>; | ||
|
||
subtitleStyle?: StyleProp<TextStyle>; | ||
|
||
toolbarContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
leadingContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
trailingContainerStyle?: StyleProp<ViewStyle>; | ||
} | ||
|
||
``` |
This file contains 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,46 @@ | ||
# Avatar | ||
|
||
API documentation for the React Native Avatar component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Avatar } from "@react-native-material/core"; | ||
// or | ||
import Avatar from "@react-native-material/core/Avatar"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface AvatarProps { | ||
label?: string | React.ReactElement | ((props: { color: string }) => React.ReactElement | null) | null; | ||
|
||
image?: ImageSourcePropType | React.ReactElement | ((props: { size: number }) => React.ReactElement | null) | null; | ||
|
||
icon?: React.ReactElement | ((props: { color: string; size: number }) => React.ReactElement | null) | null; | ||
|
||
size?: number; | ||
|
||
color?: PaletteColor; | ||
|
||
tintColor?: PaletteColor; | ||
|
||
initials?: boolean; | ||
|
||
uppercase?: boolean; | ||
|
||
autoColor?: boolean; | ||
|
||
style?: StyleProp<ViewStyle>; | ||
|
||
contentContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
imageContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
labelStyle?: StyleProp<TextStyle>; | ||
|
||
imageStyle?: StyleProp<ImageStyle>; | ||
} | ||
|
||
``` |
This file contains 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,38 @@ | ||
# BackdropSubheader | ||
|
||
API documentation for the React Native BackdropSubheader component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { BackdropSubheader } from "@react-native-material/core"; | ||
// or | ||
import BackdropSubheader from "@react-native-material/core/BackdropSubheader"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface BackdropSubheaderProps { | ||
title?: string | React.ReactElement; | ||
|
||
leading?: React.ReactElement | ((props: { color: string; size: number }) => React.ReactElement | null) | null; | ||
|
||
trailing?: React.ReactElement | ((props: { color: string; size: number }) => React.ReactElement | null) | null; | ||
|
||
divider?: boolean | React.ReactElement; | ||
|
||
color?: PaletteColor; | ||
|
||
style?: StyleProp<ViewStyle>; | ||
|
||
contentContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
titleContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
leadingContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
trailingContainerStyle?: StyleProp<ViewStyle>; | ||
} | ||
|
||
``` |
This file contains 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,42 @@ | ||
# Backdrop | ||
|
||
API documentation for the React Native Backdrop component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Backdrop } from "@react-native-material/core"; | ||
// or | ||
import Backdrop from "@react-native-material/core/Backdrop"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface BackdropProps { | ||
revealed?: boolean; | ||
|
||
header?: React.ReactElement | null; | ||
|
||
headerHeight?: number; | ||
|
||
backLayer?: React.ReactElement | null; | ||
|
||
backLayerHeight?: number; | ||
|
||
subheader?: React.ReactElement | null; | ||
|
||
subheaderHeight?: number; | ||
|
||
style?: StyleProp<ViewStyle>; | ||
|
||
headerContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
backLayerContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
frontLayerContainerStyle?: Animated.AnimatedProps<ViewProps>["style"]; | ||
|
||
subheaderContainerStyle?: StyleProp<ViewStyle>; | ||
} | ||
|
||
``` |
This file contains 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,34 @@ | ||
# Badge | ||
|
||
API documentation for the React Native Badge component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Badge } from "@react-native-material/core"; | ||
// or | ||
import Badge from "@react-native-material/core/Badge"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface BadgeProps { | ||
label?: number | string | React.ReactElement | ((props: { color: string }) => React.ReactElement | null) | null; | ||
|
||
showZero?: boolean; | ||
|
||
max?: number; | ||
|
||
visible?: boolean; | ||
|
||
color?: PaletteColor; | ||
|
||
tintColor?: PaletteColor; | ||
|
||
style?: Animated.AnimatedProps<ViewProps>["style"]; | ||
|
||
labelStyle?: StyleProp<TextStyle>; | ||
} | ||
|
||
``` |
This file contains 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,36 @@ | ||
# Banner | ||
|
||
API documentation for the React Native Banner component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Banner } from "@react-native-material/core"; | ||
// or | ||
import Banner from "@react-native-material/core/Banner"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface BannerProps { | ||
text: string | React.ReactElement | null; | ||
|
||
illustration?: React.ReactElement | ((props: { size: number }) => React.ReactElement | null) | null; | ||
|
||
buttons: React.ReactElement | React.ReactElement[] | null; | ||
|
||
style?: StyleProp<ViewStyle>; | ||
|
||
contentContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
illustrationContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
textContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
textStyle?: StyleProp<TextStyle>; | ||
|
||
actionsContainerStyle?: StyleProp<ViewStyle>; | ||
} | ||
|
||
``` |
This file contains 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,50 @@ | ||
# Button | ||
|
||
API documentation for the React Native Button component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Button } from "@react-native-material/core"; | ||
// or | ||
import Button from "@react-native-material/core/Button"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface ButtonProps extends SurfaceProps { | ||
title: string | React.ReactElement | ((props: { color: string }) => React.ReactElement | null) | null; | ||
|
||
leading?: React.ReactElement | ((props: { color: string; size: number }) => React.ReactElement | null) | null; | ||
|
||
trailing?: React.ReactElement | ((props: { color: string; size: number }) => React.ReactElement | null) | null; | ||
|
||
variant?: "contained" | "outlined" | "text"; | ||
|
||
color?: PaletteColor; | ||
|
||
tintColor?: PaletteColor; | ||
|
||
uppercase?: boolean; | ||
|
||
compact?: boolean; | ||
|
||
disableElevation?: boolean; | ||
|
||
loading?: boolean; | ||
|
||
loadingIndicator?: string | React.ReactElement | ((props: { color: string }) => React.ReactElement | null) | null; | ||
|
||
loadingIndicatorPosition?: "leading" | "trailing" | "overlay"; | ||
|
||
titleStyle?: StyleProp<TextStyle>; | ||
|
||
leadingContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
trailingContainerStyle?: StyleProp<ViewStyle>; | ||
|
||
loadingOverlayContainerStyle?: StyleProp<ViewStyle>; | ||
} | ||
|
||
``` |
This file contains 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,28 @@ | ||
# Divider | ||
|
||
API documentation for the React Native Divider component. Learn about the available props. | ||
|
||
## Import | ||
|
||
```js | ||
import { Divider } from "@react-native-material/core"; | ||
// or | ||
import Divider from "@react-native-material/core/Divider"; | ||
``` | ||
|
||
## Props | ||
|
||
```ts | ||
interface DividerProps { | ||
color?: string | undefined; | ||
|
||
inset?: number | undefined; | ||
|
||
leadingInset?: number | undefined; | ||
|
||
trailingInset?: number | undefined; | ||
|
||
style?: StyleProp<ViewStyle> | undefined; | ||
} | ||
|
||
``` |
Oops, something went wrong.
b72bcba
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.
Successfully deployed to the following URLs:
react-native-material – ./docs
react-native-material-yamankatby.vercel.app
www.react-native-material.com
react-native-material.vercel.app
react-native-material-git-main-yamankatby.vercel.app
react-native-material.com
b72bcba
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.
Successfully deployed to the following URLs:
react-native-material-example – ./example
example.react-native-material.com
react-native-material-example-yamankatby.vercel.app
react-native-material-example-git-main-yamankatby.vercel.app
react-native-material-example.vercel.app