@octans/ui 1.4.0 → 1.5.0

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.
@@ -35,11 +35,28 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
35
35
  };
36
36
  /**
37
37
  * By default padding is included in the section. Use this to disable it.
38
+ *
39
+ * This drops the HORIZONTAL padding only — the section keeps its vertical
40
+ * rhythm, so a list of rows still breathes against the sections above and
41
+ * below it. For a section with no padding at all, use `flush`.
38
42
  */
39
43
  padded: {
40
44
  type: BooleanConstructor;
41
45
  default: boolean;
42
46
  };
47
+ /**
48
+ * Removes the section's padding entirely, so its content runs to the edges
49
+ * of the card. Wins over `padded`.
50
+ *
51
+ * The reason to reach for it is a component that fills the section — a
52
+ * `DataTable`, an image, a map. Those already cancel the padding by
53
+ * reaching out of it with a negative margin, which works but means the
54
+ * component has to know what its parent's padding is; `flush` is the
55
+ * version that says so from the outside.
56
+ */
57
+ flush: {
58
+ type: BooleanConstructor;
59
+ };
43
60
  }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
44
61
  [key: string]: any;
45
62
  }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
@@ -77,13 +94,31 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
77
94
  };
78
95
  /**
79
96
  * By default padding is included in the section. Use this to disable it.
97
+ *
98
+ * This drops the HORIZONTAL padding only — the section keeps its vertical
99
+ * rhythm, so a list of rows still breathes against the sections above and
100
+ * below it. For a section with no padding at all, use `flush`.
80
101
  */
81
102
  padded: {
82
103
  type: BooleanConstructor;
83
104
  default: boolean;
84
105
  };
106
+ /**
107
+ * Removes the section's padding entirely, so its content runs to the edges
108
+ * of the card. Wins over `padded`.
109
+ *
110
+ * The reason to reach for it is a component that fills the section — a
111
+ * `DataTable`, an image, a map. Those already cancel the padding by
112
+ * reaching out of it with a negative margin, which works but means the
113
+ * component has to know what its parent's padding is; `flush` is the
114
+ * version that says so from the outside.
115
+ */
116
+ flush: {
117
+ type: BooleanConstructor;
118
+ };
85
119
  }>> & Readonly<{}>, {
86
120
  subdued: boolean;
87
121
  padded: boolean;
88
122
  collapseActions: boolean;
123
+ flush: boolean;
89
124
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
@@ -1622,12 +1622,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1622
1622
  "after-close": () => any;
1623
1623
  }, import('vue').PublicProps, {
1624
1624
  visible: boolean;
1625
- size: number;
1626
1625
  loading: boolean;
1627
1626
  peek: number;
1628
1627
  edge: import('../Sheet').SheetEdgeType;
1629
- animateInDuration: number;
1630
- animateOutDuration: number;
1631
1628
  minIndex: number;
1632
1629
  }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
1633
1630
  P: {};
@@ -1645,12 +1642,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1645
1642
  "onAfter-close"?: (() => any) | undefined;
1646
1643
  }>, {}, {}, {}, {}, {
1647
1644
  visible: boolean;
1648
- size: number;
1649
1645
  loading: boolean;
1650
1646
  peek: number;
1651
1647
  edge: import('../Sheet').SheetEdgeType;
1652
- animateInDuration: number;
1653
- animateOutDuration: number;
1654
1648
  minIndex: number;
1655
1649
  }>;
1656
1650
  __isFragment?: never;
@@ -1672,12 +1666,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1672
1666
  "after-close": () => any;
1673
1667
  }, string, {
1674
1668
  visible: boolean;
1675
- size: number;
1676
1669
  loading: boolean;
1677
1670
  peek: number;
1678
1671
  edge: import('../Sheet').SheetEdgeType;
1679
- animateInDuration: number;
1680
- animateOutDuration: number;
1681
1672
  minIndex: number;
1682
1673
  }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
1683
1674
  $slots: {
@@ -1686,6 +1677,8 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1686
1677
  actions?: (props: {}) => any;
1687
1678
  } & {
1688
1679
  default?: (props: {}) => any;
1680
+ } & {
1681
+ footer?: (props: {}) => any;
1689
1682
  };
1690
1683
  });
1691
1684
  }, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
@@ -1,11 +1,13 @@
1
1
  import { SheetProps } from './types';
2
- declare var __VLS_7: {}, __VLS_38: {}, __VLS_60: {};
2
+ declare var __VLS_7: {}, __VLS_38: {}, __VLS_60: {}, __VLS_62: {};
3
3
  type __VLS_Slots = {} & {
4
4
  external?: (props: typeof __VLS_7) => any;
5
5
  } & {
6
6
  actions?: (props: typeof __VLS_38) => any;
7
7
  } & {
8
8
  default?: (props: typeof __VLS_60) => any;
9
+ } & {
10
+ footer?: (props: typeof __VLS_62) => any;
9
11
  };
10
12
  declare const __VLS_base: import('vue').DefineComponent<SheetProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
11
13
  close: () => any;
@@ -23,12 +25,9 @@ declare const __VLS_base: import('vue').DefineComponent<SheetProps, {}, {}, {},
23
25
  "onAfter-close"?: (() => any) | undefined;
24
26
  }>, {
25
27
  visible: boolean;
26
- size: number;
27
28
  loading: boolean;
28
29
  peek: number;
29
30
  edge: import('./types').SheetEdgeType;
30
- animateInDuration: number;
31
- animateOutDuration: number;
32
31
  minIndex: number;
33
32
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
34
33
  declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
@@ -25,7 +25,10 @@ export interface SheetProps {
25
25
  * left or right sheet, its height for a top or bottom one. Clamped to the
26
26
  * screen when the sheet becomes the active (foreground) sheet.
27
27
  *
28
- * @default 700
28
+ * Left unset, it comes from `--octans-sheet-size`, so an app can set the
29
+ * width of every sheet in one place.
30
+ *
31
+ * @default '--octans-sheet-size' (700px)
29
32
  */
30
33
  size?: number;
31
34
  /**
@@ -36,22 +39,29 @@ export interface SheetProps {
36
39
  */
37
40
  peek?: number;
38
41
  /**
39
- * Adds padding around the sheet content and constrains it to a comfortable
40
- * reading width.
42
+ * Adds a gutter around the sheet content, inside the scrolling area.
43
+ *
44
+ * Padding and nothing else — it does not cap or centre the content. A sheet
45
+ * is only as wide as its `size` says, and anything that wants a reading
46
+ * measure can set one on its own content.
41
47
  */
42
48
  padded?: boolean;
43
49
  /**
44
50
  * Duration of the open (slide/fade-in) animation in milliseconds.
45
51
  * Set to `0` to open instantly with no animation.
46
52
  *
47
- * @default 700
53
+ * Left unset, it comes from `--octans-sheet-in-duration`.
54
+ *
55
+ * @default '--octans-sheet-in-duration' (700ms)
48
56
  */
49
57
  animateInDuration?: number;
50
58
  /**
51
59
  * Duration of the close (slide/fade-out) animation in milliseconds.
52
60
  * Set to `0` to close instantly with no animation.
53
61
  *
54
- * @default 700
62
+ * Left unset, it comes from `--octans-sheet-out-duration`.
63
+ *
64
+ * @default '--octans-sheet-out-duration' (700ms)
55
65
  */
56
66
  animateOutDuration?: number;
57
67
  /**
@@ -73,6 +83,15 @@ export interface SheetProps {
73
83
  * Classes to add to the sheet content element.
74
84
  */
75
85
  contentClass?: Record<string, string> | string;
86
+ /**
87
+ * Classes to add to the element wrapping the `footer` slot. The footer bar
88
+ * itself is only rendered when that slot is filled.
89
+ *
90
+ * For alignment alone, reach for `--octans-sheet-footer-align` and
91
+ * `--octans-sheet-footer-gap` first — the wrapper's own layout rules sit at
92
+ * zero specificity, so a class here wins either way.
93
+ */
94
+ footerClass?: Record<string, string> | string;
76
95
  /**
77
96
  * Shows a spinner over the whole sheet and prevents closing.
78
97
  *