UNPKG

14.7 kBTypeScriptView Raw
1import * as React from 'react';
2import { StyleProp, Animated, View, ViewStyle } from 'react-native';
3import Surface from '../Surface';
4declare type OutlinedCardProps = {
5 mode: 'outlined';
6 elevation?: never;
7};
8declare type ElevatedCardProps = {
9 mode?: 'elevated';
10 elevation?: number;
11};
12declare type Props = React.ComponentProps<typeof Surface> & {
13 /**
14 * Resting elevation of the card which controls the drop shadow.
15 */
16 elevation?: never | number;
17 /**
18 * Function to execute on long press.
19 */
20 onLongPress?: () => void;
21 /**
22 * Function to execute on press.
23 */
24 onPress?: () => void;
25 /**
26 * Mode of the Card.
27 * - `elevated` - Card with elevation.
28 * - `outlined` - Card with an outline.
29 */
30 mode?: 'elevated' | 'outlined';
31 /**
32 * Content of the `Card`.
33 */
34 children: React.ReactNode;
35 style?: StyleProp<ViewStyle>;
36 /**
37 * @optional
38 */
39 theme: ReactNativePaper.Theme;
40 /**
41 * Pass down testID from card props to touchable
42 */
43 testID?: string;
44 /**
45 * Pass down accessible from card props to touchable
46 */
47 accessible?: boolean;
48};
49declare const _default: React.ComponentType<(Pick<OutlinedCardProps & Pick<import("react-native").ViewProps & React.RefAttributes<View> & {
50 children: React.ReactNode;
51 style?: false | import("react-native").RegisteredStyle<ViewStyle> | Animated.Value | Animated.AnimatedInterpolation | Animated.WithAnimatedObject<ViewStyle> | Animated.WithAnimatedArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle> | import("react-native").RecursiveArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>> | readonly (ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>)[]> | null | undefined;
52 theme: ReactNativePaper.Theme;
53}, keyof import("react-native").ViewProps | keyof React.RefAttributes<View>> & {
54 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
55} & {
56 /**
57 * Resting elevation of the card which controls the drop shadow.
58 */
59 elevation?: number | undefined;
60 /**
61 * Function to execute on long press.
62 */
63 onLongPress?: (() => void) | undefined;
64 /**
65 * Function to execute on press.
66 */
67 onPress?: (() => void) | undefined;
68 /**
69 * Mode of the Card.
70 * - `elevated` - Card with elevation.
71 * - `outlined` - Card with an outline.
72 */
73 mode?: "outlined" | "elevated" | undefined;
74 /**
75 * Content of the `Card`.
76 */
77 children: React.ReactNode;
78 style?: StyleProp<ViewStyle>;
79 /**
80 * @optional
81 */
82 theme: ReactNativePaper.Theme;
83 /**
84 * Pass down testID from card props to touchable
85 */
86 testID?: string | undefined;
87 /**
88 * Pass down accessible from card props to touchable
89 */
90 accessible?: boolean | undefined;
91}, "onPress" | "onLongPress" | keyof import("react-native").ViewProps | keyof React.RefAttributes<View> | keyof OutlinedCardProps> | Pick<OutlinedCardProps & Pick<import("react-native").ViewProps & React.RefAttributes<View> & {
92 children: React.ReactNode;
93 style?: false | import("react-native").RegisteredStyle<ViewStyle> | Animated.Value | Animated.AnimatedInterpolation | Animated.WithAnimatedObject<ViewStyle> | Animated.WithAnimatedArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle> | import("react-native").RecursiveArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>> | readonly (ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>)[]> | null | undefined;
94 theme: ReactNativePaper.Theme;
95}, keyof import("react-native").ViewProps | keyof React.RefAttributes<View>> & {
96 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
97} & {
98 children?: React.ReactNode;
99} & {
100 /**
101 * Resting elevation of the card which controls the drop shadow.
102 */
103 elevation?: number | undefined;
104 /**
105 * Function to execute on long press.
106 */
107 onLongPress?: (() => void) | undefined;
108 /**
109 * Function to execute on press.
110 */
111 onPress?: (() => void) | undefined;
112 /**
113 * Mode of the Card.
114 * - `elevated` - Card with elevation.
115 * - `outlined` - Card with an outline.
116 */
117 mode?: "outlined" | "elevated" | undefined;
118 /**
119 * Content of the `Card`.
120 */
121 children: React.ReactNode;
122 style?: StyleProp<ViewStyle>;
123 /**
124 * @optional
125 */
126 theme: ReactNativePaper.Theme;
127 /**
128 * Pass down testID from card props to touchable
129 */
130 testID?: string | undefined;
131 /**
132 * Pass down accessible from card props to touchable
133 */
134 accessible?: boolean | undefined;
135}, "onPress" | "onLongPress" | keyof import("react-native").ViewProps | keyof React.RefAttributes<View> | keyof OutlinedCardProps> | Pick<ElevatedCardProps & Pick<import("react-native").ViewProps & React.RefAttributes<View> & {
136 children: React.ReactNode;
137 style?: false | import("react-native").RegisteredStyle<ViewStyle> | Animated.Value | Animated.AnimatedInterpolation | Animated.WithAnimatedObject<ViewStyle> | Animated.WithAnimatedArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle> | import("react-native").RecursiveArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>> | readonly (ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>)[]> | null | undefined;
138 theme: ReactNativePaper.Theme;
139}, keyof import("react-native").ViewProps | keyof React.RefAttributes<View>> & {
140 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
141} & {
142 /**
143 * Resting elevation of the card which controls the drop shadow.
144 */
145 elevation?: number | undefined;
146 /**
147 * Function to execute on long press.
148 */
149 onLongPress?: (() => void) | undefined;
150 /**
151 * Function to execute on press.
152 */
153 onPress?: (() => void) | undefined;
154 /**
155 * Mode of the Card.
156 * - `elevated` - Card with elevation.
157 * - `outlined` - Card with an outline.
158 */
159 mode?: "outlined" | "elevated" | undefined;
160 /**
161 * Content of the `Card`.
162 */
163 children: React.ReactNode;
164 style?: StyleProp<ViewStyle>;
165 /**
166 * @optional
167 */
168 theme: ReactNativePaper.Theme;
169 /**
170 * Pass down testID from card props to touchable
171 */
172 testID?: string | undefined;
173 /**
174 * Pass down accessible from card props to touchable
175 */
176 accessible?: boolean | undefined;
177}, "onPress" | "onLongPress" | keyof import("react-native").ViewProps | keyof React.RefAttributes<View> | keyof ElevatedCardProps> | Pick<ElevatedCardProps & Pick<import("react-native").ViewProps & React.RefAttributes<View> & {
178 children: React.ReactNode;
179 style?: false | import("react-native").RegisteredStyle<ViewStyle> | Animated.Value | Animated.AnimatedInterpolation | Animated.WithAnimatedObject<ViewStyle> | Animated.WithAnimatedArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle> | import("react-native").RecursiveArray<ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>> | readonly (ViewStyle | import("react-native").Falsy | import("react-native").RegisteredStyle<ViewStyle>)[]> | null | undefined;
180 theme: ReactNativePaper.Theme;
181}, keyof import("react-native").ViewProps | keyof React.RefAttributes<View>> & {
182 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
183} & {
184 children?: React.ReactNode;
185} & {
186 /**
187 * Resting elevation of the card which controls the drop shadow.
188 */
189 elevation?: number | undefined;
190 /**
191 * Function to execute on long press.
192 */
193 onLongPress?: (() => void) | undefined;
194 /**
195 * Function to execute on press.
196 */
197 onPress?: (() => void) | undefined;
198 /**
199 * Mode of the Card.
200 * - `elevated` - Card with elevation.
201 * - `outlined` - Card with an outline.
202 */
203 mode?: "outlined" | "elevated" | undefined;
204 /**
205 * Content of the `Card`.
206 */
207 children: React.ReactNode;
208 style?: StyleProp<ViewStyle>;
209 /**
210 * @optional
211 */
212 theme: ReactNativePaper.Theme;
213 /**
214 * Pass down testID from card props to touchable
215 */
216 testID?: string | undefined;
217 /**
218 * Pass down accessible from card props to touchable
219 */
220 accessible?: boolean | undefined;
221}, "onPress" | "onLongPress" | keyof import("react-native").ViewProps | keyof React.RefAttributes<View> | keyof ElevatedCardProps>) & {
222 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
223}> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<React.ComponentType<(OutlinedCardProps | ElevatedCardProps) & Props> & {
224 ({ elevation: cardElevation, onLongPress, onPress, mode: cardMode, children, style, theme, testID, accessible, ...rest }: (OutlinedCardProps | ElevatedCardProps) & Props): JSX.Element;
225 Content: {
226 ({ index, total, siblings, style, ...rest }: import("react-native").ViewProps & React.RefAttributes<View> & {
227 children: React.ReactNode;
228 index?: number | undefined;
229 total?: number | undefined;
230 siblings?: string[] | undefined;
231 style?: StyleProp<ViewStyle>;
232 }): JSX.Element;
233 displayName: string;
234 };
235 Actions: {
236 (props: import("react-native").ViewProps & React.RefAttributes<View> & {
237 children: React.ReactNode;
238 style?: StyleProp<ViewStyle>;
239 }): JSX.Element;
240 displayName: string; /**
241 * Mode of the Card.
242 * - `elevated` - Card with elevation.
243 * - `outlined` - Card with an outline.
244 */
245 };
246 Cover: React.ComponentType<Pick<import("react-native").ImageProps & React.RefAttributes<import("react-native").Image> & {
247 index?: number | undefined;
248 total?: number | undefined;
249 style?: StyleProp<ViewStyle>;
250 theme: ReactNativePaper.Theme;
251 }, keyof import("react-native").ImageProps | "index" | "total" | keyof React.RefAttributes<import("react-native").Image>> & {
252 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
253 }> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<React.ComponentType<import("react-native").ImageProps & React.RefAttributes<import("react-native").Image> & {
254 index?: number | undefined;
255 total?: number | undefined;
256 style?: StyleProp<ViewStyle>;
257 theme: ReactNativePaper.Theme;
258 }> & {
259 ({ index, total, style, theme, ...rest }: import("react-native").ImageProps & React.RefAttributes<import("react-native").Image> & {
260 index?: number | undefined;
261 total?: number | undefined;
262 style?: StyleProp<ViewStyle>;
263 theme: ReactNativePaper.Theme;
264 }): JSX.Element;
265 displayName: string;
266 }, {}>;
267 Title: React.ComponentType<Pick<import("react-native").ViewProps & React.RefAttributes<View> & {
268 title: React.ReactNode;
269 titleStyle?: StyleProp<import("react-native").TextStyle>;
270 titleNumberOfLines?: number | undefined;
271 subtitle?: React.ReactNode;
272 subtitleStyle?: StyleProp<import("react-native").TextStyle>;
273 subtitleNumberOfLines?: number | undefined;
274 left?: ((props: {
275 size: number;
276 }) => React.ReactNode) | undefined;
277 leftStyle?: StyleProp<ViewStyle>;
278 right?: ((props: {
279 size: number;
280 }) => React.ReactNode) | undefined;
281 rightStyle?: StyleProp<ViewStyle>;
282 index?: number | undefined;
283 total?: number | undefined;
284 style?: StyleProp<ViewStyle>;
285 theme: ReactNativePaper.Theme;
286 }, "title" | "left" | "right" | keyof import("react-native").ViewProps | keyof React.RefAttributes<View> | "titleStyle" | "titleNumberOfLines" | "index" | "total" | "subtitle" | "subtitleStyle" | "subtitleNumberOfLines" | "leftStyle" | "rightStyle"> & {
287 theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
288 }> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<React.ComponentType<import("react-native").ViewProps & React.RefAttributes<View> & {
289 title: React.ReactNode;
290 titleStyle?: StyleProp<import("react-native").TextStyle>;
291 titleNumberOfLines?: number | undefined;
292 subtitle?: React.ReactNode;
293 subtitleStyle?: StyleProp<import("react-native").TextStyle>;
294 subtitleNumberOfLines?: number | undefined;
295 left?: ((props: {
296 size: number;
297 }) => React.ReactNode) | undefined;
298 leftStyle?: StyleProp<ViewStyle>;
299 right?: ((props: {
300 size: number;
301 }) => React.ReactNode) | undefined;
302 rightStyle?: StyleProp<ViewStyle>;
303 index?: number | undefined;
304 total?: number | undefined;
305 style?: StyleProp<ViewStyle>;
306 theme: ReactNativePaper.Theme;
307 }> & {
308 ({ title, titleStyle, titleNumberOfLines, subtitle, subtitleStyle, subtitleNumberOfLines, left, leftStyle, right, rightStyle, style, }: import("react-native").ViewProps & React.RefAttributes<View> & {
309 title: React.ReactNode;
310 titleStyle?: StyleProp<import("react-native").TextStyle>;
311 titleNumberOfLines?: number | undefined;
312 subtitle?: React.ReactNode;
313 subtitleStyle?: StyleProp<import("react-native").TextStyle>;
314 subtitleNumberOfLines?: number | undefined;
315 left?: ((props: {
316 size: number;
317 }) => React.ReactNode) | undefined;
318 leftStyle?: StyleProp<ViewStyle>;
319 right?: ((props: {
320 size: number;
321 }) => React.ReactNode) | undefined;
322 rightStyle?: StyleProp<ViewStyle>;
323 index?: number | undefined;
324 total?: number | undefined;
325 style?: StyleProp<ViewStyle>;
326 theme: ReactNativePaper.Theme;
327 }): JSX.Element;
328 displayName: string;
329 }, {}>;
330}, {}>;
331export default _default;
332
\No newline at end of file