flet-box 1.1.2 → 1.1.3
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/AGENTS_FOR_CODE_GEN.md +284 -0
- package/CONTRIBUTING.md +238 -0
- package/README.md +2 -2
- package/bin/cli.js +88 -1
- package/bin/commands/auditFix.js +181 -27
- package/bin/commands/checkApi.js +14 -3
- package/bin/commands/checkStructure.js +368 -0
- package/bin/commands/checkSyntax.js +293 -0
- package/bin/commands/checkUi.js +666 -14
- package/bin/commands/create.js +14 -0
- package/bin/commands/createBundle.js +2 -2
- package/bin/commands/metrics.js +448 -0
- package/bin/commands/release.js +18 -0
- package/bin/commands/report.js +849 -0
- package/bin/commands/tools.js +76 -0
- package/bin/commands/unpack.js +39 -11
- package/bin/commands/verify.js +879 -0
- package/bin/mcp.js +280 -0
- package/bin/utils/contract.js +27 -0
- package/bin/utils/dtsProps.js +5 -1
- package/bin/utils/migrationGuide.js +146 -0
- package/bin/utils/moduleExports.js +9 -5
- package/bin/utils/templates.js +225 -18
- package/bin/utils/toolkit.js +191 -0
- package/docs/README.md +5 -1
- package/docs/arquitectura.md +1 -1
- package/docs/cli/README.md +168 -2
- package/docs/guides/README.md +6 -0
- package/docs/guides/accessibility.md +2 -1
- package/docs/guides/ai-toolkit.md +166 -0
- package/docs/guides/compatibility.md +1 -1
- package/docs/guides/migration.md +92 -0
- package/docs/guides/minification-and-protection.md +2 -1
- package/docs/guides/mobile-and-platforms.md +1 -1
- package/docs/guides/online-updates.md +2 -0
- package/docs/server/deployment.md +1 -1
- package/docs/tools/styling.md +2 -2
- package/docs/tools/theme.md +139 -4
- package/docs/widget/Accordion.md +74 -8
- package/docs/widget/AdMob.md +68 -3
- package/docs/widget/AdSense.md +67 -2
- package/docs/widget/AlertDialog.md +1 -1
- package/docs/widget/AnimatedBox.md +80 -39
- package/docs/widget/AnimatedText.md +74 -18
- package/docs/widget/Audio.md +73 -14
- package/docs/widget/Avatar.md +69 -4
- package/docs/widget/Badge.md +68 -3
- package/docs/widget/BottomSheet.md +2 -2
- package/docs/widget/Button.md +69 -3
- package/docs/widget/Card.md +69 -4
- package/docs/widget/Carousel.md +67 -2
- package/docs/widget/Chart.md +67 -2
- package/docs/widget/Checkbox.md +74 -8
- package/docs/widget/Chip.md +68 -3
- package/docs/widget/CircularBar.md +74 -15
- package/docs/widget/CircularChart.md +71 -10
- package/docs/widget/CodeViewer.md +67 -2
- package/docs/widget/Column.md +68 -3
- package/docs/widget/Container.md +68 -3
- package/docs/widget/DataTable.md +67 -2
- package/docs/widget/Divider.md +67 -2
- package/docs/widget/DraggBox.md +67 -2
- package/docs/widget/Dropdown.md +76 -10
- package/docs/widget/DroppBox.md +67 -2
- package/docs/widget/FloatingActionButton.md +68 -3
- package/docs/widget/GridView.md +67 -2
- package/docs/widget/Icon.md +71 -5
- package/docs/widget/Image.md +68 -3
- package/docs/widget/Input.md +68 -3
- package/docs/widget/Inspector.md +2 -2
- package/docs/widget/InstallButton.md +73 -13
- package/docs/widget/ListTile.md +69 -3
- package/docs/widget/ListView.md +67 -2
- package/docs/widget/Maps.md +68 -3
- package/docs/widget/Markdown.md +74 -15
- package/docs/widget/MatrixRain.md +72 -11
- package/docs/widget/Menu.md +209 -0
- package/docs/widget/Modal.md +3 -3
- package/docs/widget/Pagination.md +68 -3
- package/docs/widget/ParallaxBox.md +72 -12
- package/docs/widget/ProgressBar.md +69 -4
- package/docs/widget/QRCode.md +67 -2
- package/docs/widget/README.md +54 -50
- package/docs/widget/Radio.md +76 -10
- package/docs/widget/Rating.md +70 -6
- package/docs/widget/Row.md +68 -3
- package/docs/widget/Skeleton.md +68 -3
- package/docs/widget/Slider.md +75 -9
- package/docs/widget/SnackBar.md +2 -2
- package/docs/widget/Stack.md +68 -3
- package/docs/widget/Stepper.md +68 -3
- package/docs/widget/Switch.md +74 -8
- package/docs/widget/Text.md +71 -4
- package/docs/widget/ThemePicker.md +197 -0
- package/docs/widget/Tooltip.md +72 -7
- package/docs/widget/TreeView.md +70 -10
- package/docs/widget/Video.md +71 -10
- package/package.json +10 -3
- package/skills/fletbox-design/SKILL.md +89 -5
- package/skills/fletbox-motion/SKILL.md +1 -1
- package/skills/fletbox-rules/SKILL.md +56 -4
- package/src/core/runApp.js +12 -0
- package/src/index.d.ts +374 -101
- package/src/index.js +9 -0
- package/src/navigations/AdaptiveScaffold.js +2 -2
- package/src/navigations/BottomNavigation.js +1 -1
- package/src/navigations/Scaffold.js +18 -6
- package/src/tools/useState.js +11 -4
- package/src/utils/colors.js +275 -0
- package/src/utils/errorBoundary.js +288 -0
- package/src/utils/index.js +10 -2
- package/src/utils/stackPosition.js +39 -24
- package/src/utils/syntaxHighlight.js +4 -1
- package/src/utils/themes.js +279 -3
- package/src/widget-factory/addChildren.js +17 -10
- package/src/widget-factory/assignProps.js +18 -6
- package/src/widget-factory/createWidget.js +7 -0
- package/src/widget-factory/deprecations.js +77 -0
- package/src/widget-factory/translateProps.js +11 -1
- package/src/widget-factory/warnings.js +1 -27
- package/src/widget-factory/widgetFactory.js +59 -17
- package/src/widgets/Accordion.js +21 -7
- package/src/widgets/Badge.js +11 -2
- package/src/widgets/Button.js +15 -3
- package/src/widgets/Carousel.js +12 -4
- package/src/widgets/Chart.js +7 -2
- package/src/widgets/Checkbox.js +1 -2
- package/src/widgets/Chip.js +24 -10
- package/src/widgets/CircularBar.js +9 -3
- package/src/widgets/CircularChart.js +5 -3
- package/src/widgets/Container.js +6 -0
- package/src/widgets/Divider.js +3 -1
- package/src/widgets/DraggBox.js +9 -0
- package/src/widgets/Dropdown.js +3 -3
- package/src/widgets/DroppBox.js +5 -0
- package/src/widgets/FloatingActionButton.js +1 -1
- package/src/widgets/Icon.js +5 -1
- package/src/widgets/InstallButton.js +4 -2
- package/src/widgets/Markdown.js +171 -103
- package/src/widgets/Menu.js +340 -0
- package/src/widgets/Modal.js +7 -1
- package/src/widgets/Pagination.js +10 -5
- package/src/widgets/ProgressBar.js +5 -4
- package/src/widgets/QRCode.js +4 -0
- package/src/widgets/Radio.js +1 -2
- package/src/widgets/Rating.js +9 -0
- package/src/widgets/Slider.js +4 -1
- package/src/widgets/SnackBar.js +2 -2
- package/src/widgets/Switch.js +1 -2
- package/src/widgets/Text.js +9 -5
- package/src/widgets/ThemePicker.js +234 -0
- package/src/widgets/TreeView.js +2 -1
- package/src/widgets/index.js +2 -0
- package/docs/CONTRIBUTING.md +0 -156
package/docs/widget/Badge.md
CHANGED
|
@@ -28,7 +28,7 @@ const badge = Badge({
|
|
|
28
28
|
| `bgColor` | `Color` | Background color. Alias: `backgroundColor`. |
|
|
29
29
|
| `color` | `Color` | Foreground color, usually the text or icon color. |
|
|
30
30
|
| `size` | `number` | Overall size preset or pixel value, depending on the widget. |
|
|
31
|
-
| `position` | `'top-right' \| 'top-left' \| 'bottom-right' \| 'bottom-left'` |
|
|
31
|
+
| `position` | `'top-right' \| 'top-left' \| 'bottom-right' \| 'bottom-left'` | Corner of the child the badge sits on. |
|
|
32
32
|
| `offset` | `number` | The `offset` value for the widget. |
|
|
33
33
|
| `borderWidth` | `number` | Width of the border. |
|
|
34
34
|
| `borderColor` | `Color` | Color used for the border. |
|
|
@@ -41,11 +41,64 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
41
41
|
|
|
42
42
|
| Prop | Type | Description |
|
|
43
43
|
| --- | --- | --- |
|
|
44
|
+
| `full` | `boolean` | Stretches the widget to fill its parent on both axes in stack mode. |
|
|
45
|
+
| `fullHeight` | `boolean` | Stretches the widget to the full height of its parent in stack mode. |
|
|
46
|
+
| `fullWidth` | `boolean` | Stretches the widget to the full width of its parent. |
|
|
47
|
+
| `center` | `boolean` | Centres the widget on both axes in stack mode. |
|
|
48
|
+
| `centerY` | `boolean` | Centres the widget vertically in stack mode. |
|
|
49
|
+
| `centerX` | `boolean` | Centres the widget horizontally in stack mode. |
|
|
50
|
+
| `zIndex` | `number` | Stacking order: a widget with a higher value paints above lower ones. |
|
|
51
|
+
| `z` | `number` | Alias of `zIndex`. |
|
|
52
|
+
| `end` | `Size` | Logical alias of `right`, used by the stack placement shorthands. |
|
|
53
|
+
| `start` | `Size` | Logical alias of `left`, used by the stack placement shorthands. |
|
|
54
|
+
| `inset` | `Size` | Shorthand for the four edge offsets (`top`/`right`/`bottom`/`left`). |
|
|
55
|
+
| `left` | `Size` | Offset from the left edge. A number is pixels; a string uses any CSS unit. |
|
|
56
|
+
| `bottom` | `Size` | Offset from the bottom edge. A number is pixels; a string uses any CSS unit. |
|
|
57
|
+
| `right` | `Size` | Offset from the right edge. A number is pixels; a string uses any CSS unit. |
|
|
58
|
+
| `top` | `Size` | Offset from the top edge. A number is pixels; a string uses any CSS unit. |
|
|
59
|
+
| `pos` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | Alias of `position`. |
|
|
60
|
+
| `position` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | Corner of the child the badge sits on. |
|
|
44
61
|
| `width` | `Size` | Width of the widget. A number is pixels; a string uses any CSS unit. |
|
|
45
62
|
| `height` | `Size` | Height of the widget. A number is pixels; a string uses any CSS unit. |
|
|
46
63
|
| `size` | `Size` | Overall size preset or pixel value, depending on the widget. |
|
|
64
|
+
| `flex` | `number` | Flex grow/shrink/basis shorthand for a flex child. |
|
|
65
|
+
| `minWidth` | `Size` | Minimum width the widget may shrink to. |
|
|
66
|
+
| `maxWidth` | `Size` | Maximum width the widget may grow to. |
|
|
67
|
+
| `minHeight` | `Size` | Minimum height the widget may shrink to. |
|
|
68
|
+
| `maxHeight` | `Size` | Maximum height the widget may grow to. |
|
|
69
|
+
| `border` | `string` | CSS `border` shorthand for all four edges: width, style and color in one string. |
|
|
70
|
+
| `borderTop` | `string` | The top edge of the border alone, for a widget whose rim differs per side. |
|
|
71
|
+
| `borderBottom` | `string` | The bottom edge of the border alone, for a widget whose rim differs per side. |
|
|
72
|
+
| `borderLeft` | `string` | The left edge of the border alone, for a widget whose rim differs per side. |
|
|
73
|
+
| `borderRight` | `string` | The right edge of the border alone, for a widget whose rim differs per side. |
|
|
74
|
+
| `cursor` | `string` | CSS `cursor` value: what the pointer becomes over the widget (`pointer`, `grab`, `not-allowed`). |
|
|
75
|
+
| `display` | `string` | CSS `display` value for the container. |
|
|
76
|
+
| `boxSizing` | `'border-box' \| 'content-box'` | Which box `width` and `height` measure: `border-box` keeps the size you asked for and pushes padding inward. |
|
|
77
|
+
| `flexDirection` | `'row' \| 'column' \| 'row-reverse' \| 'column-reverse'` | Main axis of a flex container: `row` places children side by side, `column` stacks them. |
|
|
78
|
+
| `flexGrow` | `number` | Share of the leftover space this child takes, relative to its siblings. |
|
|
79
|
+
| `flexShrink` | `number` | How readily the child gives space back when the row overflows; `0` keeps its size. |
|
|
80
|
+
| `gap` | `number \| string` | Space between children along the layout axis. |
|
|
81
|
+
| `fontSize` | `number` | Size of the font. |
|
|
82
|
+
| `borderColor` | `Color` | Color used for the border. |
|
|
83
|
+
| `borderWidth` | `number` | Width of the border. |
|
|
47
84
|
| `padding` | `Padding` | Space inside the widget, between its content and its border. |
|
|
85
|
+
| `paddingTop` | `Size` | Space inside the widget, on the top edge only. |
|
|
86
|
+
| `paddingRight` | `Size` | Space inside the widget, on the right edge only. |
|
|
87
|
+
| `paddingBottom` | `Size` | Space inside the widget, on the bottom edge only. |
|
|
88
|
+
| `paddingLeft` | `Size` | Space inside the widget, on the left edge only. |
|
|
89
|
+
| `pt` | `Size` | Alias of `paddingTop`. |
|
|
90
|
+
| `pr` | `Size` | Alias of `paddingRight`. |
|
|
91
|
+
| `pb` | `Size` | Alias of `paddingBottom`. |
|
|
92
|
+
| `pl` | `Size` | Alias of `paddingLeft`. |
|
|
48
93
|
| `margin` | `Margin` | Space outside the widget, between it and its neighbors. |
|
|
94
|
+
| `marginTop` | `Size` | Space outside the widget, on the top edge only. |
|
|
95
|
+
| `marginRight` | `Size` | Space outside the widget, on the right edge only. |
|
|
96
|
+
| `marginBottom` | `Size` | Space outside the widget, on the bottom edge only. |
|
|
97
|
+
| `marginLeft` | `Size` | Space outside the widget, on the left edge only. |
|
|
98
|
+
| `mt` | `Size` | Alias of `marginTop`. |
|
|
99
|
+
| `mr` | `Size` | Alias of `marginRight`. |
|
|
100
|
+
| `mb` | `Size` | Alias of `marginBottom`. |
|
|
101
|
+
| `ml` | `Size` | Alias of `marginLeft`. |
|
|
49
102
|
| `bgColor` | `Color` | Background color. Alias: `backgroundColor`. |
|
|
50
103
|
| `backgroundColor` | `Color` | Background color. Alias of `bgColor`. |
|
|
51
104
|
| `color` | `Color` | Foreground color, usually the text or icon color. |
|
|
@@ -55,11 +108,23 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
55
108
|
| `filter` | `string` | Raw CSS `filter` value applied to the widget itself, e.g. `blur(4px)`. |
|
|
56
109
|
| `backdropFilter` | `string` | Raw CSS `backdrop-filter` value: what sits behind the widget is blurred through it, which is what makes a translucent card frosted glass. |
|
|
57
110
|
| `maskImage` | `string` | Raw CSS `mask-image` value, used to fade a widget out at its edges instead of cutting it. |
|
|
111
|
+
| `bgImage` | `string` | Image painted behind the widget's content (CSS `background-image`), placed with `bgSize` and `bgPosition`. |
|
|
112
|
+
| `bgSize` | `string` | How the background image fills its box (`cover`, `contain`, or a length). |
|
|
113
|
+
| `bgPosition` | `string` | Where the background image is anchored (`center`, `top`, `50% 20%`). |
|
|
114
|
+
| `bgRepeat` | `string` | Whether the background image tiles; `no-repeat` for a single cover. |
|
|
58
115
|
| `opacity` | `number` | Opacity from 0 (invisible) to 1 (fully opaque). |
|
|
59
116
|
| `visible` | `boolean` | Whether the widget is rendered and visible. |
|
|
60
117
|
| `disabled` | `boolean` | Disables interaction and shows the non-interactive state. |
|
|
61
|
-
| `onPress` | `(
|
|
62
|
-
| `onClick` | `(
|
|
118
|
+
| `onPress` | `(event?: Event) => void` | Callback fired when the widget is pressed. Alias: `onClick`. |
|
|
119
|
+
| `onClick` | `(event?: Event) => void` | Callback fired when the widget is clicked. Alias: `onPress`. |
|
|
120
|
+
| `onclick` | `(event?: Event) => void` | Lowercase alias of `onClick`, kept because the shipped templates and the HTML habit write it. |
|
|
121
|
+
| `alignSelf` | `AlignSelf` | Overrides the parent's `alignItems` for this child alone (CSS `align-self`). Alias: `selfAlign`. |
|
|
122
|
+
| `selfAlign` | `AlignSelf` | Alias of `alignSelf`. |
|
|
123
|
+
| `overflow` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | How overflowing content is handled (`hidden`, `auto`, `scroll`). |
|
|
124
|
+
| `overflowX` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowX` value for the widget. |
|
|
125
|
+
| `overflowY` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowY` value for the widget. |
|
|
126
|
+
| `textOverflow` | `'clip' \| 'ellipsis' \| string` | The `textOverflow` value for the widget. |
|
|
127
|
+
| `whiteSpace` | `'normal' \| 'nowrap' \| 'pre' \| 'pre-wrap' \| 'pre-line' \| string` | The `whiteSpace` value for the widget. |
|
|
63
128
|
| `id` | `string` | DOM `id` for the rendered element. |
|
|
64
129
|
| `className` | `string` | CSS class names applied to the rendered element. |
|
|
65
130
|
| `ref` | `(widget: Widget) => void` | Callback that receives the underlying DOM node. |
|
|
@@ -46,7 +46,7 @@ const sheet = BottomSheet({
|
|
|
46
46
|
| `dragHandleWidth` | `number` | Width of the drag handle. |
|
|
47
47
|
| `dragHandleHeight` | `number` | Height of the drag handle. |
|
|
48
48
|
| `animationDuration` | `number` | Duration for the animation, in milliseconds. |
|
|
49
|
-
| `zIndex` | `number` |
|
|
49
|
+
| `zIndex` | `number` | Stacking order: a widget with a higher value paints above lower ones. |
|
|
50
50
|
| `overlayZIndex` | `number` | Index used for the overlay z. |
|
|
51
51
|
| `onOpen` | `() => void` | Fired when the overlay opens. |
|
|
52
52
|
| `onClose` | `() => void` | Fired when the overlay closes. |
|
|
@@ -122,4 +122,4 @@ const filters = BottomSheet({
|
|
|
122
122
|
- **Next:** [SnackBar](SnackBar.md)
|
|
123
123
|
- **Index:** [Widget index](README.md) · [Start here](START_HERE.md)
|
|
124
124
|
|
|
125
|
-
You are reading **Chapter 4 · Feedback and overlays** (3 of
|
|
125
|
+
You are reading **Chapter 4 · Feedback and overlays** (3 of 11).
|
package/docs/widget/Button.md
CHANGED
|
@@ -48,11 +48,64 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
48
48
|
|
|
49
49
|
| Prop | Type | Description |
|
|
50
50
|
| --- | --- | --- |
|
|
51
|
+
| `full` | `boolean` | Stretches the widget to fill its parent on both axes in stack mode. |
|
|
52
|
+
| `fullHeight` | `boolean` | Stretches the widget to the full height of its parent in stack mode. |
|
|
53
|
+
| `fullWidth` | `boolean` | Stretches the widget to the full width of its parent. |
|
|
54
|
+
| `center` | `boolean` | Centres the widget on both axes in stack mode. |
|
|
55
|
+
| `centerY` | `boolean` | Centres the widget vertically in stack mode. |
|
|
56
|
+
| `centerX` | `boolean` | Centres the widget horizontally in stack mode. |
|
|
57
|
+
| `zIndex` | `number` | Stacking order: a widget with a higher value paints above lower ones. |
|
|
58
|
+
| `z` | `number` | Alias of `zIndex`. |
|
|
59
|
+
| `end` | `Size` | Logical alias of `right`, used by the stack placement shorthands. |
|
|
60
|
+
| `start` | `Size` | Logical alias of `left`, used by the stack placement shorthands. |
|
|
61
|
+
| `inset` | `Size` | Shorthand for the four edge offsets (`top`/`right`/`bottom`/`left`). |
|
|
62
|
+
| `left` | `Size` | Offset from the left edge. A number is pixels; a string uses any CSS unit. |
|
|
63
|
+
| `bottom` | `Size` | Offset from the bottom edge. A number is pixels; a string uses any CSS unit. |
|
|
64
|
+
| `right` | `Size` | Offset from the right edge. A number is pixels; a string uses any CSS unit. |
|
|
65
|
+
| `top` | `Size` | Offset from the top edge. A number is pixels; a string uses any CSS unit. |
|
|
66
|
+
| `pos` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | Alias of `position`. |
|
|
67
|
+
| `position` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | CSS `position` value, or `stack` for centered stacking. |
|
|
51
68
|
| `width` | `Size` | Width of the widget. A number is pixels; a string uses any CSS unit. |
|
|
52
69
|
| `height` | `Size` | Height of the widget. A number is pixels; a string uses any CSS unit. |
|
|
53
70
|
| `size` | `Size` | Overall size preset or pixel value, depending on the widget. |
|
|
71
|
+
| `flex` | `number` | Flex grow/shrink/basis shorthand for a flex child. |
|
|
72
|
+
| `minWidth` | `Size` | Minimum width the widget may shrink to. |
|
|
73
|
+
| `maxWidth` | `Size` | Maximum width the widget may grow to. |
|
|
74
|
+
| `minHeight` | `Size` | Minimum height the widget may shrink to. |
|
|
75
|
+
| `maxHeight` | `Size` | Maximum height the widget may grow to. |
|
|
76
|
+
| `border` | `string` | CSS `border` shorthand for all four edges: width, style and color in one string. |
|
|
77
|
+
| `borderTop` | `string` | The top edge of the border alone, for a widget whose rim differs per side. |
|
|
78
|
+
| `borderBottom` | `string` | The bottom edge of the border alone, for a widget whose rim differs per side. |
|
|
79
|
+
| `borderLeft` | `string` | The left edge of the border alone, for a widget whose rim differs per side. |
|
|
80
|
+
| `borderRight` | `string` | The right edge of the border alone, for a widget whose rim differs per side. |
|
|
81
|
+
| `cursor` | `string` | CSS `cursor` value: what the pointer becomes over the widget (`pointer`, `grab`, `not-allowed`). |
|
|
82
|
+
| `display` | `string` | CSS `display` value for the container. |
|
|
83
|
+
| `boxSizing` | `'border-box' \| 'content-box'` | Which box `width` and `height` measure: `border-box` keeps the size you asked for and pushes padding inward. |
|
|
84
|
+
| `flexDirection` | `'row' \| 'column' \| 'row-reverse' \| 'column-reverse'` | Main axis of a flex container: `row` places children side by side, `column` stacks them. |
|
|
85
|
+
| `flexGrow` | `number` | Share of the leftover space this child takes, relative to its siblings. |
|
|
86
|
+
| `flexShrink` | `number` | How readily the child gives space back when the row overflows; `0` keeps its size. |
|
|
87
|
+
| `gap` | `number \| string` | Space between children along the layout axis. |
|
|
88
|
+
| `fontSize` | `number` | Size of the font. |
|
|
89
|
+
| `borderColor` | `Color` | Color used for the border. |
|
|
90
|
+
| `borderWidth` | `number` | Width of the border. |
|
|
54
91
|
| `padding` | `Padding` | Space inside the widget, between its content and its border. |
|
|
92
|
+
| `paddingTop` | `Size` | Space inside the widget, on the top edge only. |
|
|
93
|
+
| `paddingRight` | `Size` | Space inside the widget, on the right edge only. |
|
|
94
|
+
| `paddingBottom` | `Size` | Space inside the widget, on the bottom edge only. |
|
|
95
|
+
| `paddingLeft` | `Size` | Space inside the widget, on the left edge only. |
|
|
96
|
+
| `pt` | `Size` | Alias of `paddingTop`. |
|
|
97
|
+
| `pr` | `Size` | Alias of `paddingRight`. |
|
|
98
|
+
| `pb` | `Size` | Alias of `paddingBottom`. |
|
|
99
|
+
| `pl` | `Size` | Alias of `paddingLeft`. |
|
|
55
100
|
| `margin` | `Margin` | Space outside the widget, between it and its neighbors. |
|
|
101
|
+
| `marginTop` | `Size` | Space outside the widget, on the top edge only. |
|
|
102
|
+
| `marginRight` | `Size` | Space outside the widget, on the right edge only. |
|
|
103
|
+
| `marginBottom` | `Size` | Space outside the widget, on the bottom edge only. |
|
|
104
|
+
| `marginLeft` | `Size` | Space outside the widget, on the left edge only. |
|
|
105
|
+
| `mt` | `Size` | Alias of `marginTop`. |
|
|
106
|
+
| `mr` | `Size` | Alias of `marginRight`. |
|
|
107
|
+
| `mb` | `Size` | Alias of `marginBottom`. |
|
|
108
|
+
| `ml` | `Size` | Alias of `marginLeft`. |
|
|
56
109
|
| `bgColor` | `Color` | Background color. Alias: `backgroundColor`. |
|
|
57
110
|
| `backgroundColor` | `Color` | Background color. Alias of `bgColor`. |
|
|
58
111
|
| `color` | `Color` | Foreground color, usually the text or icon color. |
|
|
@@ -62,11 +115,23 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
62
115
|
| `filter` | `string` | Raw CSS `filter` value applied to the widget itself, e.g. `blur(4px)`. |
|
|
63
116
|
| `backdropFilter` | `string` | Raw CSS `backdrop-filter` value: what sits behind the widget is blurred through it, which is what makes a translucent card frosted glass. |
|
|
64
117
|
| `maskImage` | `string` | Raw CSS `mask-image` value, used to fade a widget out at its edges instead of cutting it. |
|
|
118
|
+
| `bgImage` | `string` | Image painted behind the widget's content (CSS `background-image`), placed with `bgSize` and `bgPosition`. |
|
|
119
|
+
| `bgSize` | `string` | How the background image fills its box (`cover`, `contain`, or a length). |
|
|
120
|
+
| `bgPosition` | `string` | Where the background image is anchored (`center`, `top`, `50% 20%`). |
|
|
121
|
+
| `bgRepeat` | `string` | Whether the background image tiles; `no-repeat` for a single cover. |
|
|
65
122
|
| `opacity` | `number` | Opacity from 0 (invisible) to 1 (fully opaque). |
|
|
66
123
|
| `visible` | `boolean` | Whether the widget is rendered and visible. |
|
|
67
124
|
| `disabled` | `boolean` | Disables interaction and shows the non-interactive state. |
|
|
68
|
-
| `onPress` | `(
|
|
69
|
-
| `onClick` | `(
|
|
125
|
+
| `onPress` | `(event?: Event) => void` | Callback fired when the widget is pressed. Alias: `onClick`. |
|
|
126
|
+
| `onClick` | `(event?: Event) => void` | Callback fired when the widget is clicked. Alias: `onPress`. |
|
|
127
|
+
| `onclick` | `(event?: Event) => void` | Lowercase alias of `onClick`, kept because the shipped templates and the HTML habit write it. |
|
|
128
|
+
| `alignSelf` | `AlignSelf` | Overrides the parent's `alignItems` for this child alone (CSS `align-self`). Alias: `selfAlign`. |
|
|
129
|
+
| `selfAlign` | `AlignSelf` | Alias of `alignSelf`. |
|
|
130
|
+
| `overflow` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | How overflowing content is handled (`hidden`, `auto`, `scroll`). |
|
|
131
|
+
| `overflowX` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowX` value for the widget. |
|
|
132
|
+
| `overflowY` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowY` value for the widget. |
|
|
133
|
+
| `textOverflow` | `'clip' \| 'ellipsis' \| string` | The `textOverflow` value for the widget. |
|
|
134
|
+
| `whiteSpace` | `'normal' \| 'nowrap' \| 'pre' \| 'pre-wrap' \| 'pre-line' \| string` | The `whiteSpace` value for the widget. |
|
|
70
135
|
| `id` | `string` | DOM `id` for the rendered element. |
|
|
71
136
|
| `className` | `string` | CSS class names applied to the rendered element. |
|
|
72
137
|
| `ref` | `(widget: Widget) => void` | Callback that receives the underlying DOM node. |
|
|
@@ -122,6 +187,7 @@ const checkout = Button({
|
|
|
122
187
|
|
|
123
188
|
- Size presets control padding, font size, and icon size; `fullWidth` stretches the button to 100%.
|
|
124
189
|
- `onPress` receives no arguments and is wired to the native click; `elevation` picks a shadow level.
|
|
190
|
+
- The label is one line. A longer `text` is ellipsized instead of wrapped, so a fixed-height pill keeps its shape and the words never run through the rounded ends; the full string stays the accessible name. A block of copy that needs to wrap belongs in a card or a list tile, not in a button.
|
|
125
191
|
|
|
126
192
|
## Related widgets
|
|
127
193
|
|
|
@@ -138,4 +204,4 @@ const checkout = Button({
|
|
|
138
204
|
- **Next:** [Input](Input.md)
|
|
139
205
|
- **Index:** [Widget index](README.md) · [Start here](START_HERE.md)
|
|
140
206
|
|
|
141
|
-
You are reading **Chapter 2 · Interaction basics** (1 of
|
|
207
|
+
You are reading **Chapter 2 · Interaction basics** (1 of 9).
|
package/docs/widget/Card.md
CHANGED
|
@@ -31,7 +31,7 @@ const card = Card({
|
|
|
31
31
|
| `borderWidth` | `number` | Width of the border. |
|
|
32
32
|
| `borderStyle` | `'solid' \| 'dashed' \| 'dotted'` | The `borderStyle` value for the widget. |
|
|
33
33
|
| `borderColor` | `Color` | Color used for the border. |
|
|
34
|
-
| `onPress` | `(
|
|
34
|
+
| `onPress` | `(event?: Event) => void` | Callback fired when the widget is pressed. Alias: `onClick`. |
|
|
35
35
|
|
|
36
36
|
### Common props
|
|
37
37
|
|
|
@@ -39,11 +39,64 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
39
39
|
|
|
40
40
|
| Prop | Type | Description |
|
|
41
41
|
| --- | --- | --- |
|
|
42
|
+
| `full` | `boolean` | Stretches the widget to fill its parent on both axes in stack mode. |
|
|
43
|
+
| `fullHeight` | `boolean` | Stretches the widget to the full height of its parent in stack mode. |
|
|
44
|
+
| `fullWidth` | `boolean` | Stretches the widget to the full width of its parent. |
|
|
45
|
+
| `center` | `boolean` | Centres the widget on both axes in stack mode. |
|
|
46
|
+
| `centerY` | `boolean` | Centres the widget vertically in stack mode. |
|
|
47
|
+
| `centerX` | `boolean` | Centres the widget horizontally in stack mode. |
|
|
48
|
+
| `zIndex` | `number` | Stacking order: a widget with a higher value paints above lower ones. |
|
|
49
|
+
| `z` | `number` | Alias of `zIndex`. |
|
|
50
|
+
| `end` | `Size` | Logical alias of `right`, used by the stack placement shorthands. |
|
|
51
|
+
| `start` | `Size` | Logical alias of `left`, used by the stack placement shorthands. |
|
|
52
|
+
| `inset` | `Size` | Shorthand for the four edge offsets (`top`/`right`/`bottom`/`left`). |
|
|
53
|
+
| `left` | `Size` | Offset from the left edge. A number is pixels; a string uses any CSS unit. |
|
|
54
|
+
| `bottom` | `Size` | Offset from the bottom edge. A number is pixels; a string uses any CSS unit. |
|
|
55
|
+
| `right` | `Size` | Offset from the right edge. A number is pixels; a string uses any CSS unit. |
|
|
56
|
+
| `top` | `Size` | Offset from the top edge. A number is pixels; a string uses any CSS unit. |
|
|
57
|
+
| `pos` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | Alias of `position`. |
|
|
58
|
+
| `position` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | CSS `position` value, or `stack` for centered stacking. |
|
|
42
59
|
| `width` | `Size` | Width of the widget. A number is pixels; a string uses any CSS unit. |
|
|
43
60
|
| `height` | `Size` | Height of the widget. A number is pixels; a string uses any CSS unit. |
|
|
44
61
|
| `size` | `Size` | Overall size preset or pixel value, depending on the widget. |
|
|
62
|
+
| `flex` | `number` | Flex grow/shrink/basis shorthand for a flex child. |
|
|
63
|
+
| `minWidth` | `Size` | Minimum width the widget may shrink to. |
|
|
64
|
+
| `maxWidth` | `Size` | Maximum width the widget may grow to. |
|
|
65
|
+
| `minHeight` | `Size` | Minimum height the widget may shrink to. |
|
|
66
|
+
| `maxHeight` | `Size` | Maximum height the widget may grow to. |
|
|
67
|
+
| `border` | `string` | CSS `border` shorthand for all four edges: width, style and color in one string. |
|
|
68
|
+
| `borderTop` | `string` | The top edge of the border alone, for a widget whose rim differs per side. |
|
|
69
|
+
| `borderBottom` | `string` | The bottom edge of the border alone, for a widget whose rim differs per side. |
|
|
70
|
+
| `borderLeft` | `string` | The left edge of the border alone, for a widget whose rim differs per side. |
|
|
71
|
+
| `borderRight` | `string` | The right edge of the border alone, for a widget whose rim differs per side. |
|
|
72
|
+
| `cursor` | `string` | CSS `cursor` value: what the pointer becomes over the widget (`pointer`, `grab`, `not-allowed`). |
|
|
73
|
+
| `display` | `string` | CSS `display` value for the container. |
|
|
74
|
+
| `boxSizing` | `'border-box' \| 'content-box'` | Which box `width` and `height` measure: `border-box` keeps the size you asked for and pushes padding inward. |
|
|
75
|
+
| `flexDirection` | `'row' \| 'column' \| 'row-reverse' \| 'column-reverse'` | Main axis of a flex container: `row` places children side by side, `column` stacks them. |
|
|
76
|
+
| `flexGrow` | `number` | Share of the leftover space this child takes, relative to its siblings. |
|
|
77
|
+
| `flexShrink` | `number` | How readily the child gives space back when the row overflows; `0` keeps its size. |
|
|
78
|
+
| `gap` | `number \| string` | Space between children along the layout axis. |
|
|
79
|
+
| `fontSize` | `number` | Size of the font. |
|
|
80
|
+
| `borderColor` | `Color` | Color used for the border. |
|
|
81
|
+
| `borderWidth` | `number` | Width of the border. |
|
|
45
82
|
| `padding` | `Padding` | Space inside the widget, between its content and its border. |
|
|
83
|
+
| `paddingTop` | `Size` | Space inside the widget, on the top edge only. |
|
|
84
|
+
| `paddingRight` | `Size` | Space inside the widget, on the right edge only. |
|
|
85
|
+
| `paddingBottom` | `Size` | Space inside the widget, on the bottom edge only. |
|
|
86
|
+
| `paddingLeft` | `Size` | Space inside the widget, on the left edge only. |
|
|
87
|
+
| `pt` | `Size` | Alias of `paddingTop`. |
|
|
88
|
+
| `pr` | `Size` | Alias of `paddingRight`. |
|
|
89
|
+
| `pb` | `Size` | Alias of `paddingBottom`. |
|
|
90
|
+
| `pl` | `Size` | Alias of `paddingLeft`. |
|
|
46
91
|
| `margin` | `Margin` | Space outside the widget, between it and its neighbors. |
|
|
92
|
+
| `marginTop` | `Size` | Space outside the widget, on the top edge only. |
|
|
93
|
+
| `marginRight` | `Size` | Space outside the widget, on the right edge only. |
|
|
94
|
+
| `marginBottom` | `Size` | Space outside the widget, on the bottom edge only. |
|
|
95
|
+
| `marginLeft` | `Size` | Space outside the widget, on the left edge only. |
|
|
96
|
+
| `mt` | `Size` | Alias of `marginTop`. |
|
|
97
|
+
| `mr` | `Size` | Alias of `marginRight`. |
|
|
98
|
+
| `mb` | `Size` | Alias of `marginBottom`. |
|
|
99
|
+
| `ml` | `Size` | Alias of `marginLeft`. |
|
|
47
100
|
| `bgColor` | `Color` | Background color. Alias: `backgroundColor`. |
|
|
48
101
|
| `backgroundColor` | `Color` | Background color. Alias of `bgColor`. |
|
|
49
102
|
| `color` | `Color` | Foreground color, usually the text or icon color. |
|
|
@@ -53,11 +106,23 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
53
106
|
| `filter` | `string` | Raw CSS `filter` value applied to the widget itself, e.g. `blur(4px)`. |
|
|
54
107
|
| `backdropFilter` | `string` | Raw CSS `backdrop-filter` value: what sits behind the widget is blurred through it, which is what makes a translucent card frosted glass. |
|
|
55
108
|
| `maskImage` | `string` | Raw CSS `mask-image` value, used to fade a widget out at its edges instead of cutting it. |
|
|
109
|
+
| `bgImage` | `string` | Image painted behind the widget's content (CSS `background-image`), placed with `bgSize` and `bgPosition`. |
|
|
110
|
+
| `bgSize` | `string` | How the background image fills its box (`cover`, `contain`, or a length). |
|
|
111
|
+
| `bgPosition` | `string` | Where the background image is anchored (`center`, `top`, `50% 20%`). |
|
|
112
|
+
| `bgRepeat` | `string` | Whether the background image tiles; `no-repeat` for a single cover. |
|
|
56
113
|
| `opacity` | `number` | Opacity from 0 (invisible) to 1 (fully opaque). |
|
|
57
114
|
| `visible` | `boolean` | Whether the widget is rendered and visible. |
|
|
58
115
|
| `disabled` | `boolean` | Disables interaction and shows the non-interactive state. |
|
|
59
|
-
| `onPress` | `(
|
|
60
|
-
| `onClick` | `(
|
|
116
|
+
| `onPress` | `(event?: Event) => void` | Callback fired when the widget is pressed. Alias: `onClick`. |
|
|
117
|
+
| `onClick` | `(event?: Event) => void` | Callback fired when the widget is clicked. Alias: `onPress`. |
|
|
118
|
+
| `onclick` | `(event?: Event) => void` | Lowercase alias of `onClick`, kept because the shipped templates and the HTML habit write it. |
|
|
119
|
+
| `alignSelf` | `AlignSelf` | Overrides the parent's `alignItems` for this child alone (CSS `align-self`). Alias: `selfAlign`. |
|
|
120
|
+
| `selfAlign` | `AlignSelf` | Alias of `alignSelf`. |
|
|
121
|
+
| `overflow` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | How overflowing content is handled (`hidden`, `auto`, `scroll`). |
|
|
122
|
+
| `overflowX` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowX` value for the widget. |
|
|
123
|
+
| `overflowY` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowY` value for the widget. |
|
|
124
|
+
| `textOverflow` | `'clip' \| 'ellipsis' \| string` | The `textOverflow` value for the widget. |
|
|
125
|
+
| `whiteSpace` | `'normal' \| 'nowrap' \| 'pre' \| 'pre-wrap' \| 'pre-line' \| string` | The `whiteSpace` value for the widget. |
|
|
61
126
|
| `id` | `string` | DOM `id` for the rendered element. |
|
|
62
127
|
| `className` | `string` | CSS class names applied to the rendered element. |
|
|
63
128
|
| `ref` | `(widget: Widget) => void` | Callback that receives the underlying DOM node. |
|
|
@@ -122,7 +187,7 @@ const card = Card({
|
|
|
122
187
|
|
|
123
188
|
## Continue reading
|
|
124
189
|
|
|
125
|
-
- **Previous:** [
|
|
190
|
+
- **Previous:** [ThemePicker](ThemePicker.md)
|
|
126
191
|
- **Next:** [Divider](Divider.md)
|
|
127
192
|
- **Index:** [Widget index](README.md) · [Start here](START_HERE.md)
|
|
128
193
|
|
package/docs/widget/Carousel.md
CHANGED
|
@@ -48,11 +48,64 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
48
48
|
|
|
49
49
|
| Prop | Type | Description |
|
|
50
50
|
| --- | --- | --- |
|
|
51
|
+
| `full` | `boolean` | Stretches the widget to fill its parent on both axes in stack mode. |
|
|
52
|
+
| `fullHeight` | `boolean` | Stretches the widget to the full height of its parent in stack mode. |
|
|
53
|
+
| `fullWidth` | `boolean` | Stretches the widget to the full width of its parent. |
|
|
54
|
+
| `center` | `boolean` | Centres the widget on both axes in stack mode. |
|
|
55
|
+
| `centerY` | `boolean` | Centres the widget vertically in stack mode. |
|
|
56
|
+
| `centerX` | `boolean` | Centres the widget horizontally in stack mode. |
|
|
57
|
+
| `zIndex` | `number` | Stacking order: a widget with a higher value paints above lower ones. |
|
|
58
|
+
| `z` | `number` | Alias of `zIndex`. |
|
|
59
|
+
| `end` | `Size` | Logical alias of `right`, used by the stack placement shorthands. |
|
|
60
|
+
| `start` | `Size` | Logical alias of `left`, used by the stack placement shorthands. |
|
|
61
|
+
| `inset` | `Size` | Shorthand for the four edge offsets (`top`/`right`/`bottom`/`left`). |
|
|
62
|
+
| `left` | `Size` | Offset from the left edge. A number is pixels; a string uses any CSS unit. |
|
|
63
|
+
| `bottom` | `Size` | Offset from the bottom edge. A number is pixels; a string uses any CSS unit. |
|
|
64
|
+
| `right` | `Size` | Offset from the right edge. A number is pixels; a string uses any CSS unit. |
|
|
65
|
+
| `top` | `Size` | Offset from the top edge. A number is pixels; a string uses any CSS unit. |
|
|
66
|
+
| `pos` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | Alias of `position`. |
|
|
67
|
+
| `position` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | CSS `position` value, or `stack` for centered stacking. |
|
|
51
68
|
| `width` | `Size` | Width of the widget. A number is pixels; a string uses any CSS unit. |
|
|
52
69
|
| `height` | `Size` | Height of the widget. A number is pixels; a string uses any CSS unit. |
|
|
53
70
|
| `size` | `Size` | Overall size preset or pixel value, depending on the widget. |
|
|
71
|
+
| `flex` | `number` | Flex grow/shrink/basis shorthand for a flex child. |
|
|
72
|
+
| `minWidth` | `Size` | Minimum width the widget may shrink to. |
|
|
73
|
+
| `maxWidth` | `Size` | Maximum width the widget may grow to. |
|
|
74
|
+
| `minHeight` | `Size` | Minimum height the widget may shrink to. |
|
|
75
|
+
| `maxHeight` | `Size` | Maximum height the widget may grow to. |
|
|
76
|
+
| `border` | `string` | CSS `border` shorthand for all four edges: width, style and color in one string. |
|
|
77
|
+
| `borderTop` | `string` | The top edge of the border alone, for a widget whose rim differs per side. |
|
|
78
|
+
| `borderBottom` | `string` | The bottom edge of the border alone, for a widget whose rim differs per side. |
|
|
79
|
+
| `borderLeft` | `string` | The left edge of the border alone, for a widget whose rim differs per side. |
|
|
80
|
+
| `borderRight` | `string` | The right edge of the border alone, for a widget whose rim differs per side. |
|
|
81
|
+
| `cursor` | `string` | CSS `cursor` value: what the pointer becomes over the widget (`pointer`, `grab`, `not-allowed`). |
|
|
82
|
+
| `display` | `string` | CSS `display` value for the container. |
|
|
83
|
+
| `boxSizing` | `'border-box' \| 'content-box'` | Which box `width` and `height` measure: `border-box` keeps the size you asked for and pushes padding inward. |
|
|
84
|
+
| `flexDirection` | `'row' \| 'column' \| 'row-reverse' \| 'column-reverse'` | Main axis of a flex container: `row` places children side by side, `column` stacks them. |
|
|
85
|
+
| `flexGrow` | `number` | Share of the leftover space this child takes, relative to its siblings. |
|
|
86
|
+
| `flexShrink` | `number` | How readily the child gives space back when the row overflows; `0` keeps its size. |
|
|
87
|
+
| `gap` | `number \| string` | Space between children along the layout axis. |
|
|
88
|
+
| `fontSize` | `number` | Size of the font. |
|
|
89
|
+
| `borderColor` | `Color` | Color used for the border. |
|
|
90
|
+
| `borderWidth` | `number` | Width of the border. |
|
|
54
91
|
| `padding` | `Padding` | Space inside the widget, between its content and its border. |
|
|
92
|
+
| `paddingTop` | `Size` | Space inside the widget, on the top edge only. |
|
|
93
|
+
| `paddingRight` | `Size` | Space inside the widget, on the right edge only. |
|
|
94
|
+
| `paddingBottom` | `Size` | Space inside the widget, on the bottom edge only. |
|
|
95
|
+
| `paddingLeft` | `Size` | Space inside the widget, on the left edge only. |
|
|
96
|
+
| `pt` | `Size` | Alias of `paddingTop`. |
|
|
97
|
+
| `pr` | `Size` | Alias of `paddingRight`. |
|
|
98
|
+
| `pb` | `Size` | Alias of `paddingBottom`. |
|
|
99
|
+
| `pl` | `Size` | Alias of `paddingLeft`. |
|
|
55
100
|
| `margin` | `Margin` | Space outside the widget, between it and its neighbors. |
|
|
101
|
+
| `marginTop` | `Size` | Space outside the widget, on the top edge only. |
|
|
102
|
+
| `marginRight` | `Size` | Space outside the widget, on the right edge only. |
|
|
103
|
+
| `marginBottom` | `Size` | Space outside the widget, on the bottom edge only. |
|
|
104
|
+
| `marginLeft` | `Size` | Space outside the widget, on the left edge only. |
|
|
105
|
+
| `mt` | `Size` | Alias of `marginTop`. |
|
|
106
|
+
| `mr` | `Size` | Alias of `marginRight`. |
|
|
107
|
+
| `mb` | `Size` | Alias of `marginBottom`. |
|
|
108
|
+
| `ml` | `Size` | Alias of `marginLeft`. |
|
|
56
109
|
| `bgColor` | `Color` | Background color. Alias: `backgroundColor`. |
|
|
57
110
|
| `backgroundColor` | `Color` | Background color. Alias of `bgColor`. |
|
|
58
111
|
| `color` | `Color` | Foreground color, usually the text or icon color. |
|
|
@@ -62,11 +115,23 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
62
115
|
| `filter` | `string` | Raw CSS `filter` value applied to the widget itself, e.g. `blur(4px)`. |
|
|
63
116
|
| `backdropFilter` | `string` | Raw CSS `backdrop-filter` value: what sits behind the widget is blurred through it, which is what makes a translucent card frosted glass. |
|
|
64
117
|
| `maskImage` | `string` | Raw CSS `mask-image` value, used to fade a widget out at its edges instead of cutting it. |
|
|
118
|
+
| `bgImage` | `string` | Image painted behind the widget's content (CSS `background-image`), placed with `bgSize` and `bgPosition`. |
|
|
119
|
+
| `bgSize` | `string` | How the background image fills its box (`cover`, `contain`, or a length). |
|
|
120
|
+
| `bgPosition` | `string` | Where the background image is anchored (`center`, `top`, `50% 20%`). |
|
|
121
|
+
| `bgRepeat` | `string` | Whether the background image tiles; `no-repeat` for a single cover. |
|
|
65
122
|
| `opacity` | `number` | Opacity from 0 (invisible) to 1 (fully opaque). |
|
|
66
123
|
| `visible` | `boolean` | Whether the widget is rendered and visible. |
|
|
67
124
|
| `disabled` | `boolean` | Disables interaction and shows the non-interactive state. |
|
|
68
|
-
| `onPress` | `(
|
|
69
|
-
| `onClick` | `(
|
|
125
|
+
| `onPress` | `(event?: Event) => void` | Callback fired when the widget is pressed. Alias: `onClick`. |
|
|
126
|
+
| `onClick` | `(event?: Event) => void` | Callback fired when the widget is clicked. Alias: `onPress`. |
|
|
127
|
+
| `onclick` | `(event?: Event) => void` | Lowercase alias of `onClick`, kept because the shipped templates and the HTML habit write it. |
|
|
128
|
+
| `alignSelf` | `AlignSelf` | Overrides the parent's `alignItems` for this child alone (CSS `align-self`). Alias: `selfAlign`. |
|
|
129
|
+
| `selfAlign` | `AlignSelf` | Alias of `alignSelf`. |
|
|
130
|
+
| `overflow` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | How overflowing content is handled (`hidden`, `auto`, `scroll`). |
|
|
131
|
+
| `overflowX` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowX` value for the widget. |
|
|
132
|
+
| `overflowY` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowY` value for the widget. |
|
|
133
|
+
| `textOverflow` | `'clip' \| 'ellipsis' \| string` | The `textOverflow` value for the widget. |
|
|
134
|
+
| `whiteSpace` | `'normal' \| 'nowrap' \| 'pre' \| 'pre-wrap' \| 'pre-line' \| string` | The `whiteSpace` value for the widget. |
|
|
70
135
|
| `id` | `string` | DOM `id` for the rendered element. |
|
|
71
136
|
| `className` | `string` | CSS class names applied to the rendered element. |
|
|
72
137
|
| `ref` | `(widget: Widget) => void` | Callback that receives the underlying DOM node. |
|
package/docs/widget/Chart.md
CHANGED
|
@@ -54,11 +54,64 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
54
54
|
|
|
55
55
|
| Prop | Type | Description |
|
|
56
56
|
| --- | --- | --- |
|
|
57
|
+
| `full` | `boolean` | Stretches the widget to fill its parent on both axes in stack mode. |
|
|
58
|
+
| `fullHeight` | `boolean` | Stretches the widget to the full height of its parent in stack mode. |
|
|
59
|
+
| `fullWidth` | `boolean` | Stretches the widget to the full width of its parent. |
|
|
60
|
+
| `center` | `boolean` | Centres the widget on both axes in stack mode. |
|
|
61
|
+
| `centerY` | `boolean` | Centres the widget vertically in stack mode. |
|
|
62
|
+
| `centerX` | `boolean` | Centres the widget horizontally in stack mode. |
|
|
63
|
+
| `zIndex` | `number` | Stacking order: a widget with a higher value paints above lower ones. |
|
|
64
|
+
| `z` | `number` | Alias of `zIndex`. |
|
|
65
|
+
| `end` | `Size` | Logical alias of `right`, used by the stack placement shorthands. |
|
|
66
|
+
| `start` | `Size` | Logical alias of `left`, used by the stack placement shorthands. |
|
|
67
|
+
| `inset` | `Size` | Shorthand for the four edge offsets (`top`/`right`/`bottom`/`left`). |
|
|
68
|
+
| `left` | `Size` | Offset from the left edge. A number is pixels; a string uses any CSS unit. |
|
|
69
|
+
| `bottom` | `Size` | Offset from the bottom edge. A number is pixels; a string uses any CSS unit. |
|
|
70
|
+
| `right` | `Size` | Offset from the right edge. A number is pixels; a string uses any CSS unit. |
|
|
71
|
+
| `top` | `Size` | Offset from the top edge. A number is pixels; a string uses any CSS unit. |
|
|
72
|
+
| `pos` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | Alias of `position`. |
|
|
73
|
+
| `position` | `'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky' \| 'stack'` | CSS `position` value, or `stack` for centered stacking. |
|
|
57
74
|
| `width` | `Size` | Width of the widget. A number is pixels; a string uses any CSS unit. |
|
|
58
75
|
| `height` | `Size` | Height of the widget. A number is pixels; a string uses any CSS unit. |
|
|
59
76
|
| `size` | `Size` | Overall size preset or pixel value, depending on the widget. |
|
|
77
|
+
| `flex` | `number` | Flex grow/shrink/basis shorthand for a flex child. |
|
|
78
|
+
| `minWidth` | `Size` | Minimum width the widget may shrink to. |
|
|
79
|
+
| `maxWidth` | `Size` | Maximum width the widget may grow to. |
|
|
80
|
+
| `minHeight` | `Size` | Minimum height the widget may shrink to. |
|
|
81
|
+
| `maxHeight` | `Size` | Maximum height the widget may grow to. |
|
|
82
|
+
| `border` | `string` | CSS `border` shorthand for all four edges: width, style and color in one string. |
|
|
83
|
+
| `borderTop` | `string` | The top edge of the border alone, for a widget whose rim differs per side. |
|
|
84
|
+
| `borderBottom` | `string` | The bottom edge of the border alone, for a widget whose rim differs per side. |
|
|
85
|
+
| `borderLeft` | `string` | The left edge of the border alone, for a widget whose rim differs per side. |
|
|
86
|
+
| `borderRight` | `string` | The right edge of the border alone, for a widget whose rim differs per side. |
|
|
87
|
+
| `cursor` | `string` | CSS `cursor` value: what the pointer becomes over the widget (`pointer`, `grab`, `not-allowed`). |
|
|
88
|
+
| `display` | `string` | CSS `display` value for the container. |
|
|
89
|
+
| `boxSizing` | `'border-box' \| 'content-box'` | Which box `width` and `height` measure: `border-box` keeps the size you asked for and pushes padding inward. |
|
|
90
|
+
| `flexDirection` | `'row' \| 'column' \| 'row-reverse' \| 'column-reverse'` | Main axis of a flex container: `row` places children side by side, `column` stacks them. |
|
|
91
|
+
| `flexGrow` | `number` | Share of the leftover space this child takes, relative to its siblings. |
|
|
92
|
+
| `flexShrink` | `number` | How readily the child gives space back when the row overflows; `0` keeps its size. |
|
|
93
|
+
| `gap` | `number \| string` | Space between children along the layout axis. |
|
|
94
|
+
| `fontSize` | `number` | Size of the font. |
|
|
95
|
+
| `borderColor` | `Color` | Color used for the border. |
|
|
96
|
+
| `borderWidth` | `number` | Width of the border. |
|
|
60
97
|
| `padding` | `Padding` | Space inside the widget, between its content and its border. |
|
|
98
|
+
| `paddingTop` | `Size` | Space inside the widget, on the top edge only. |
|
|
99
|
+
| `paddingRight` | `Size` | Space inside the widget, on the right edge only. |
|
|
100
|
+
| `paddingBottom` | `Size` | Space inside the widget, on the bottom edge only. |
|
|
101
|
+
| `paddingLeft` | `Size` | Space inside the widget, on the left edge only. |
|
|
102
|
+
| `pt` | `Size` | Alias of `paddingTop`. |
|
|
103
|
+
| `pr` | `Size` | Alias of `paddingRight`. |
|
|
104
|
+
| `pb` | `Size` | Alias of `paddingBottom`. |
|
|
105
|
+
| `pl` | `Size` | Alias of `paddingLeft`. |
|
|
61
106
|
| `margin` | `Margin` | Space outside the widget, between it and its neighbors. |
|
|
107
|
+
| `marginTop` | `Size` | Space outside the widget, on the top edge only. |
|
|
108
|
+
| `marginRight` | `Size` | Space outside the widget, on the right edge only. |
|
|
109
|
+
| `marginBottom` | `Size` | Space outside the widget, on the bottom edge only. |
|
|
110
|
+
| `marginLeft` | `Size` | Space outside the widget, on the left edge only. |
|
|
111
|
+
| `mt` | `Size` | Alias of `marginTop`. |
|
|
112
|
+
| `mr` | `Size` | Alias of `marginRight`. |
|
|
113
|
+
| `mb` | `Size` | Alias of `marginBottom`. |
|
|
114
|
+
| `ml` | `Size` | Alias of `marginLeft`. |
|
|
62
115
|
| `bgColor` | `Color` | Background color. Alias: `backgroundColor`. |
|
|
63
116
|
| `backgroundColor` | `Color` | Background color. Alias of `bgColor`. |
|
|
64
117
|
| `color` | `Color` | Foreground color, usually the text or icon color. |
|
|
@@ -68,11 +121,23 @@ Every widget also accepts these shared props — see [common props](COMMON_PROPS
|
|
|
68
121
|
| `filter` | `string` | Raw CSS `filter` value applied to the widget itself, e.g. `blur(4px)`. |
|
|
69
122
|
| `backdropFilter` | `string` | Raw CSS `backdrop-filter` value: what sits behind the widget is blurred through it, which is what makes a translucent card frosted glass. |
|
|
70
123
|
| `maskImage` | `string` | Raw CSS `mask-image` value, used to fade a widget out at its edges instead of cutting it. |
|
|
124
|
+
| `bgImage` | `string` | Image painted behind the widget's content (CSS `background-image`), placed with `bgSize` and `bgPosition`. |
|
|
125
|
+
| `bgSize` | `string` | How the background image fills its box (`cover`, `contain`, or a length). |
|
|
126
|
+
| `bgPosition` | `string` | Where the background image is anchored (`center`, `top`, `50% 20%`). |
|
|
127
|
+
| `bgRepeat` | `string` | Whether the background image tiles; `no-repeat` for a single cover. |
|
|
71
128
|
| `opacity` | `number` | Opacity from 0 (invisible) to 1 (fully opaque). |
|
|
72
129
|
| `visible` | `boolean` | Whether the widget is rendered and visible. |
|
|
73
130
|
| `disabled` | `boolean` | Disables interaction and shows the non-interactive state. |
|
|
74
|
-
| `onPress` | `(
|
|
75
|
-
| `onClick` | `(
|
|
131
|
+
| `onPress` | `(event?: Event) => void` | Callback fired when the widget is pressed. Alias: `onClick`. |
|
|
132
|
+
| `onClick` | `(event?: Event) => void` | Callback fired when the widget is clicked. Alias: `onPress`. |
|
|
133
|
+
| `onclick` | `(event?: Event) => void` | Lowercase alias of `onClick`, kept because the shipped templates and the HTML habit write it. |
|
|
134
|
+
| `alignSelf` | `AlignSelf` | Overrides the parent's `alignItems` for this child alone (CSS `align-self`). Alias: `selfAlign`. |
|
|
135
|
+
| `selfAlign` | `AlignSelf` | Alias of `alignSelf`. |
|
|
136
|
+
| `overflow` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | How overflowing content is handled (`hidden`, `auto`, `scroll`). |
|
|
137
|
+
| `overflowX` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowX` value for the widget. |
|
|
138
|
+
| `overflowY` | `'auto' \| 'hidden' \| 'visible' \| 'scroll' \| 'clip'` | The `overflowY` value for the widget. |
|
|
139
|
+
| `textOverflow` | `'clip' \| 'ellipsis' \| string` | The `textOverflow` value for the widget. |
|
|
140
|
+
| `whiteSpace` | `'normal' \| 'nowrap' \| 'pre' \| 'pre-wrap' \| 'pre-line' \| string` | The `whiteSpace` value for the widget. |
|
|
76
141
|
| `id` | `string` | DOM `id` for the rendered element. |
|
|
77
142
|
| `className` | `string` | CSS class names applied to the rendered element. |
|
|
78
143
|
| `ref` | `(widget: Widget) => void` | Callback that receives the underlying DOM node. |
|