@webority-technologies/mobile 0.0.6 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -463
- package/lib/commonjs/components/Skeleton/Skeleton.js +20 -12
- package/lib/commonjs/components/Skeleton/SkeletonContent.js +25 -9
- package/lib/commonjs/components/Skeleton/SkeletonList.js +7 -2
- package/lib/commonjs/components/Skeleton/SkeletonProvider.js +48 -0
- package/lib/commonjs/components/Skeleton/SkeletonSkip.js +37 -0
- package/lib/commonjs/components/Skeleton/index.js +20 -0
- package/lib/commonjs/components/index.js +18 -0
- package/lib/module/components/Skeleton/Skeleton.js +20 -12
- package/lib/module/components/Skeleton/SkeletonContent.js +25 -9
- package/lib/module/components/Skeleton/SkeletonList.js +7 -2
- package/lib/module/components/Skeleton/SkeletonProvider.js +41 -0
- package/lib/module/components/Skeleton/SkeletonSkip.js +31 -0
- package/lib/module/components/Skeleton/index.js +2 -0
- package/lib/module/components/index.js +1 -1
- package/lib/typescript/commonjs/components/Skeleton/Skeleton.d.ts +9 -0
- package/lib/typescript/commonjs/components/Skeleton/SkeletonContent.d.ts +6 -0
- package/lib/typescript/commonjs/components/Skeleton/SkeletonList.d.ts +3 -0
- package/lib/typescript/commonjs/components/Skeleton/SkeletonProvider.d.ts +32 -0
- package/lib/typescript/commonjs/components/Skeleton/SkeletonSkip.d.ts +25 -0
- package/lib/typescript/commonjs/components/Skeleton/index.d.ts +4 -0
- package/lib/typescript/commonjs/components/index.d.ts +2 -2
- package/lib/typescript/module/components/Skeleton/Skeleton.d.ts +9 -0
- package/lib/typescript/module/components/Skeleton/SkeletonContent.d.ts +6 -0
- package/lib/typescript/module/components/Skeleton/SkeletonList.d.ts +3 -0
- package/lib/typescript/module/components/Skeleton/SkeletonProvider.d.ts +32 -0
- package/lib/typescript/module/components/Skeleton/SkeletonSkip.d.ts +25 -0
- package/lib/typescript/module/components/Skeleton/index.d.ts +4 -0
- package/lib/typescript/module/components/index.d.ts +2 -2
- package/package.json +1 -1
|
@@ -4,4 +4,8 @@ export { SkeletonContent } from './SkeletonContent';
|
|
|
4
4
|
export type { SkeletonContentProps, SkeletonContentMode } from './SkeletonContent';
|
|
5
5
|
export { SkeletonList } from './SkeletonList';
|
|
6
6
|
export type { SkeletonListProps } from './SkeletonList';
|
|
7
|
+
export { SkeletonProvider, useSkeletonDefaults } from './SkeletonProvider';
|
|
8
|
+
export type { SkeletonColors, SkeletonProviderDefaults, SkeletonProviderProps } from './SkeletonProvider';
|
|
9
|
+
export { SkeletonSkip } from './SkeletonSkip';
|
|
10
|
+
export type { SkeletonSkipProps } from './SkeletonSkip';
|
|
7
11
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -70,8 +70,8 @@ export { Select } from './Select';
|
|
|
70
70
|
export type { SelectProps, SelectOption, SelectSize } from './Select';
|
|
71
71
|
export { Stepper } from './Stepper';
|
|
72
72
|
export type { StepperProps, StepperVariant, StepperStep, StepperTone } from './Stepper';
|
|
73
|
-
export { Skeleton, SkeletonAvatar, SkeletonCard, SkeletonCircle, SkeletonContent, SkeletonList, SkeletonListItem, SkeletonText } from './Skeleton';
|
|
74
|
-
export type {
|
|
73
|
+
export { Skeleton, SkeletonAvatar, SkeletonCard, SkeletonCircle, SkeletonContent, SkeletonList, SkeletonListItem, SkeletonProvider, SkeletonSkip, SkeletonText, useSkeletonDefaults } from './Skeleton';
|
|
74
|
+
export type { SkeletonAvatarProps, SkeletonCardProps, SkeletonCircleProps, SkeletonColors, SkeletonContentMode, SkeletonContentProps, SkeletonListItemProps, SkeletonListProps, SkeletonProps, SkeletonProviderDefaults, SkeletonProviderProps, SkeletonSkipProps, SkeletonSpeed, SkeletonTextProps, SkeletonVariant } from './Skeleton';
|
|
75
75
|
export { Slider } from './Slider';
|
|
76
76
|
export type { SliderProps, SliderTone, SliderSize } from './Slider';
|
|
77
77
|
export { Swipeable } from './Swipeable';
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import type { StyleProp, ViewStyle } from 'react-native';
|
|
3
3
|
import type { RadiusScale } from '../../theme/types';
|
|
4
|
+
import type { SkeletonColors } from './SkeletonProvider';
|
|
4
5
|
export type SkeletonVariant = 'shimmer' | 'pulse';
|
|
5
6
|
export type SkeletonSpeed = 'slow' | 'normal' | 'fast';
|
|
6
7
|
export type SkeletonRadius = keyof Pick<RadiusScale, 'sm' | 'md' | 'lg' | 'xl' | 'full'> | number;
|
|
@@ -12,6 +13,14 @@ export interface SkeletonProps {
|
|
|
12
13
|
radius?: SkeletonRadius;
|
|
13
14
|
variant?: SkeletonVariant;
|
|
14
15
|
speed?: SkeletonSpeed;
|
|
16
|
+
/**
|
|
17
|
+
* Per-instance colour override. Either `background` or `highlight` (or both)
|
|
18
|
+
* can be set; missing keys fall back to the SkeletonProvider's defaults
|
|
19
|
+
* and finally to the theme. Use this for one-off contrast adjustments
|
|
20
|
+
* (dark shimmer on a light banner, etc.) — for app-wide overrides prefer
|
|
21
|
+
* `<SkeletonProvider colors={{...}}>`.
|
|
22
|
+
*/
|
|
23
|
+
colors?: SkeletonColors;
|
|
15
24
|
style?: StyleProp<ViewStyle>;
|
|
16
25
|
testID?: string;
|
|
17
26
|
}
|
|
@@ -2,6 +2,7 @@ import React from 'react';
|
|
|
2
2
|
import type { ReactNode } from 'react';
|
|
3
3
|
import type { StyleProp, ViewStyle } from 'react-native';
|
|
4
4
|
import type { SkeletonSpeed, SkeletonVariant } from './Skeleton';
|
|
5
|
+
import type { SkeletonColors } from './SkeletonProvider';
|
|
5
6
|
export type SkeletonContentMode = 'auto' | 'block';
|
|
6
7
|
export interface SkeletonContentProps {
|
|
7
8
|
/** When true, replace children with skeleton placeholders. */
|
|
@@ -26,6 +27,11 @@ export interface SkeletonContentProps {
|
|
|
26
27
|
* `loading` is false. Default: `1`.
|
|
27
28
|
*/
|
|
28
29
|
count?: number;
|
|
30
|
+
/**
|
|
31
|
+
* Colour override forwarded to every `<Skeleton>` produced by the walker. Either or both
|
|
32
|
+
* keys can be set; missing keys fall back to provider defaults / theme.
|
|
33
|
+
*/
|
|
34
|
+
colors?: SkeletonColors;
|
|
29
35
|
style?: StyleProp<ViewStyle>;
|
|
30
36
|
testID?: string;
|
|
31
37
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { ReactElement, ReactNode } from 'react';
|
|
2
2
|
import type { FlatListProps, StyleProp, ViewStyle } from 'react-native';
|
|
3
3
|
import type { SkeletonSpeed, SkeletonVariant } from './Skeleton';
|
|
4
|
+
import type { SkeletonColors } from './SkeletonProvider';
|
|
4
5
|
export interface SkeletonListProps<ItemT> extends Omit<FlatListProps<ItemT>, 'data' | 'renderItem'> {
|
|
5
6
|
/** Whether the list is in its initial loading state. */
|
|
6
7
|
loading: boolean;
|
|
@@ -19,6 +20,8 @@ export interface SkeletonListProps<ItemT> extends Omit<FlatListProps<ItemT>, 'da
|
|
|
19
20
|
variant?: SkeletonVariant;
|
|
20
21
|
/** Animation speed — same as Skeleton. */
|
|
21
22
|
speed?: SkeletonSpeed;
|
|
23
|
+
/** Colour override forwarded to the placeholder skeletons. */
|
|
24
|
+
colors?: SkeletonColors;
|
|
22
25
|
/** Style applied to the wrapper View around the placeholders. */
|
|
23
26
|
placeholderContainerStyle?: StyleProp<ViewStyle>;
|
|
24
27
|
testID?: string;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import type { ReactNode } from 'react';
|
|
3
|
+
import type { SkeletonRadius, SkeletonSpeed, SkeletonVariant } from './Skeleton';
|
|
4
|
+
/**
|
|
5
|
+
* Per-instance color override for a skeleton. `background` is the resting tone
|
|
6
|
+
* of the placeholder; `highlight` is the moving shimmer band (or pulse fade).
|
|
7
|
+
* Either can be omitted — missing keys fall back to the active theme.
|
|
8
|
+
*/
|
|
9
|
+
export interface SkeletonColors {
|
|
10
|
+
background?: string;
|
|
11
|
+
highlight?: string;
|
|
12
|
+
}
|
|
13
|
+
export interface SkeletonProviderDefaults {
|
|
14
|
+
variant?: SkeletonVariant;
|
|
15
|
+
speed?: SkeletonSpeed;
|
|
16
|
+
/** Default `placeholderCount` for `<SkeletonList>` when not specified per-instance. */
|
|
17
|
+
placeholderCount?: number;
|
|
18
|
+
/** Default `radius` for `<Skeleton>` when not specified per-instance. */
|
|
19
|
+
radius?: SkeletonRadius;
|
|
20
|
+
/** App-wide colour overrides for the shimmer base + highlight. */
|
|
21
|
+
colors?: SkeletonColors;
|
|
22
|
+
}
|
|
23
|
+
export interface SkeletonProviderProps extends SkeletonProviderDefaults {
|
|
24
|
+
children: ReactNode;
|
|
25
|
+
}
|
|
26
|
+
export declare const SkeletonProvider: React.FC<SkeletonProviderProps>;
|
|
27
|
+
/**
|
|
28
|
+
* Read the current SkeletonProvider defaults. Returns an empty object when no
|
|
29
|
+
* provider is mounted, so the skeleton primitives still work outside of one.
|
|
30
|
+
*/
|
|
31
|
+
export declare const useSkeletonDefaults: () => SkeletonProviderDefaults;
|
|
32
|
+
//# sourceMappingURL=SkeletonProvider.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import type { ReactNode } from 'react';
|
|
3
|
+
export interface SkeletonSkipProps {
|
|
4
|
+
children: ReactNode;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Pass-through marker that opts a subtree out of `SkeletonContent`'s auto walker.
|
|
8
|
+
*
|
|
9
|
+
* The walker recognizes this element type and returns its children unchanged
|
|
10
|
+
* even while `loading` is true. Use it to keep a specific Text/Image/View
|
|
11
|
+
* visible inside a skeleton block — e.g., a brand mark, a status icon, or a
|
|
12
|
+
* decorative element that should never shimmer.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* <SkeletonContent loading>
|
|
16
|
+
* <View style={styles.card}>
|
|
17
|
+
* <SkeletonSkip>
|
|
18
|
+
* <Image source={Logo} style={styles.brandMark} />
|
|
19
|
+
* </SkeletonSkip>
|
|
20
|
+
* <Text>Loading…</Text>
|
|
21
|
+
* </View>
|
|
22
|
+
* </SkeletonContent>
|
|
23
|
+
*/
|
|
24
|
+
export declare const SkeletonSkip: React.FC<SkeletonSkipProps>;
|
|
25
|
+
//# sourceMappingURL=SkeletonSkip.d.ts.map
|
|
@@ -4,4 +4,8 @@ export { SkeletonContent } from './SkeletonContent';
|
|
|
4
4
|
export type { SkeletonContentProps, SkeletonContentMode } from './SkeletonContent';
|
|
5
5
|
export { SkeletonList } from './SkeletonList';
|
|
6
6
|
export type { SkeletonListProps } from './SkeletonList';
|
|
7
|
+
export { SkeletonProvider, useSkeletonDefaults } from './SkeletonProvider';
|
|
8
|
+
export type { SkeletonColors, SkeletonProviderDefaults, SkeletonProviderProps } from './SkeletonProvider';
|
|
9
|
+
export { SkeletonSkip } from './SkeletonSkip';
|
|
10
|
+
export type { SkeletonSkipProps } from './SkeletonSkip';
|
|
7
11
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -70,8 +70,8 @@ export { Select } from './Select';
|
|
|
70
70
|
export type { SelectProps, SelectOption, SelectSize } from './Select';
|
|
71
71
|
export { Stepper } from './Stepper';
|
|
72
72
|
export type { StepperProps, StepperVariant, StepperStep, StepperTone } from './Stepper';
|
|
73
|
-
export { Skeleton, SkeletonAvatar, SkeletonCard, SkeletonCircle, SkeletonContent, SkeletonList, SkeletonListItem, SkeletonText } from './Skeleton';
|
|
74
|
-
export type {
|
|
73
|
+
export { Skeleton, SkeletonAvatar, SkeletonCard, SkeletonCircle, SkeletonContent, SkeletonList, SkeletonListItem, SkeletonProvider, SkeletonSkip, SkeletonText, useSkeletonDefaults } from './Skeleton';
|
|
74
|
+
export type { SkeletonAvatarProps, SkeletonCardProps, SkeletonCircleProps, SkeletonColors, SkeletonContentMode, SkeletonContentProps, SkeletonListItemProps, SkeletonListProps, SkeletonProps, SkeletonProviderDefaults, SkeletonProviderProps, SkeletonSkipProps, SkeletonSpeed, SkeletonTextProps, SkeletonVariant } from './Skeleton';
|
|
75
75
|
export { Slider } from './Slider';
|
|
76
76
|
export type { SliderProps, SliderTone, SliderSize } from './Slider';
|
|
77
77
|
export { Swipeable } from './Swipeable';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webority-technologies/mobile",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "Beautiful, animated, accessible React Native components plus API/auth/logging/network/storage utilities for Webority projects.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react-native",
|