@jirawatpyk/aura-react 5.33.0 → 5.35.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.
- package/README.md +16 -2
- package/dist/aura.bundle.js +831 -412
- package/dist/cjs/index.cjs +830 -411
- package/dist/esm/ActionBar.js +1 -0
- package/dist/esm/AppShell.js +16 -2
- package/dist/esm/BottomNav.js +26 -2
- package/dist/esm/StatusTile.js +53 -0
- package/dist/esm/autoTip.js +5 -0
- package/dist/esm/breakpoints.js +18 -1
- package/dist/esm/index.js +5 -0
- package/dist/esm/responsive.js +1 -15
- package/dist/esm/scrollHide.js +96 -0
- package/dist/esm/strings.js +5 -0
- package/dist/esm/strings.sv.js +5 -0
- package/dist/esm/strings.th.js +5 -0
- package/dist/esm/tiles.js +220 -0
- package/dist/index.d.cts +126 -36
- package/dist/index.d.ts +126 -36
- package/dist/locales/sv.cjs +5 -0
- package/dist/locales/sv.d.cts +7 -0
- package/dist/locales/sv.d.ts +7 -0
- package/dist/locales/th.cjs +5 -0
- package/dist/locales/th.d.cts +7 -0
- package/dist/locales/th.d.ts +7 -0
- package/dist/server/index.cjs +274 -27
- package/dist/server/index.d.cts +78 -0
- package/dist/server/index.d.ts +78 -0
- package/dist/server/index.js +274 -27
- package/dist/styles.css +86 -5
- package/dist/styles.layer.css +86 -5
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1214,6 +1214,10 @@ export interface AppShellProps {
|
|
|
1214
1214
|
* as when there is no `header`: from lg up it is hidden and `--aura-shell-bar-height` is 0. For apps whose phone
|
|
1215
1215
|
* pages have a top bar (brand, avatar) and whose desktop pages don't. Default: the bar shows at every width. */
|
|
1216
1216
|
headerHideFrom?: "lg" | undefined;
|
|
1217
|
+
/** 5.35 (DxT Monitor #13): below 1024px the top bar slides up while the page scrolls down and comes back on the way
|
|
1218
|
+
* up, near the top, and when focus enters it; `--aura-shell-bar-height` is 0 while it is away, so headers pinned
|
|
1219
|
+
* under it follow. No motion with reduced motion. Default false. */
|
|
1220
|
+
headerHideOnScroll?: boolean | undefined;
|
|
1217
1221
|
children?: React$1.ReactNode | undefined;
|
|
1218
1222
|
navLabel?: string | undefined;
|
|
1219
1223
|
menuLabel?: string | undefined;
|
|
@@ -1324,6 +1328,10 @@ export interface ActionBarProps {
|
|
|
1324
1328
|
* parent, so they never cover the last field. Make it the last child of the form or card it belongs to: like any
|
|
1325
1329
|
* `position: sticky` element it sticks only while that parent is on screen. */
|
|
1326
1330
|
position?: "viewport" | "container" | undefined;
|
|
1331
|
+
/** 5.35 (DxT Monitor #14): while this bar is on the page, a BottomNav (and its spacer) is hidden and the bar takes the
|
|
1332
|
+
* bottom edge — for a page whose own actions (Acknowledge, Visit site) replace the tab bar. Any element can do the
|
|
1333
|
+
* same with the `data-aura-hide-bottomnav` attribute. */
|
|
1334
|
+
hidesBottomNav?: boolean | undefined;
|
|
1327
1335
|
/** Bulk actions: the number of selected rows. Shows "N selected" in the status; at 0 the bar hides (its live region
|
|
1328
1336
|
* stays, so the next selection is announced) and its actions leave the tab order. */
|
|
1329
1337
|
selected?: number | undefined;
|
|
@@ -1365,6 +1373,10 @@ export interface BottomNavProps {
|
|
|
1365
1373
|
linkComponent?: React$1.ElementType | undefined;
|
|
1366
1374
|
/** Hidden from this breakpoint up, in CSS (so the server's HTML is right). Default `lg` (1024px); `false` never hides. */
|
|
1367
1375
|
hideFrom?: "md" | "lg" | "xl" | false | undefined;
|
|
1376
|
+
/** 5.35 (DxT Monitor #14): slides down out of view while the page scrolls down and comes back on the way up, near the
|
|
1377
|
+
* top, and when focus enters it. Viewport ActionBars and toasts follow it down. Default false. To keep it away on a
|
|
1378
|
+
* page with its own bottom bar, see ActionBar `hidesBottomNav` (or `data-aura-hide-bottomnav` on your own bar). */
|
|
1379
|
+
hideOnScroll?: boolean | undefined;
|
|
1368
1380
|
className?: string | undefined;
|
|
1369
1381
|
}
|
|
1370
1382
|
export interface StatChange {
|
|
@@ -1614,6 +1626,71 @@ export interface Theme {
|
|
|
1614
1626
|
/** CSS overriding the tokens. No selector: the whole page. A selector (".tenant-acme") scopes it. Load after aura.css. */
|
|
1615
1627
|
css(selector?: string): string;
|
|
1616
1628
|
}
|
|
1629
|
+
/** A monitored thing's state on a StatusTile. */
|
|
1630
|
+
export type StatusTileStatus = "down" | "problem" | "maintenance" | "ok" | "unknown";
|
|
1631
|
+
/** A colour for a tile's value or a marker: `danger`, `warning`, `accent` (violet), `neutral` (grey) or `default`
|
|
1632
|
+
* (the text colour). */
|
|
1633
|
+
export type TileTone = "danger" | "warning" | "accent" | "neutral" | "default";
|
|
1634
|
+
/** A small icon at the end of a StatusTile's second line ("SSL expires soon", "Muted"). */
|
|
1635
|
+
export interface StatusTileMarker {
|
|
1636
|
+
icon: IconInput;
|
|
1637
|
+
/** What it means. Read with the tile's name and shown as a tip on hover (a mouse only: on a phone, say it on the
|
|
1638
|
+
* detail page too). */
|
|
1639
|
+
label: string;
|
|
1640
|
+
/** Default `neutral`. */
|
|
1641
|
+
tone?: TileTone | undefined;
|
|
1642
|
+
}
|
|
1643
|
+
export interface StatusTileProps extends Pick<React$1.HTMLAttributes<HTMLElement>, "id" | "style" | "lang" | "dir">, React$1.AriaAttributes, DataAttributes {
|
|
1644
|
+
/** down (red), problem (amber), maintenance (violet), ok (grey) or unknown (5.35: no data yet — a dashed circle on
|
|
1645
|
+
* the plain surface). Each has its own icon too, so colour is never the only sign. */
|
|
1646
|
+
status: StatusTileStatus;
|
|
1647
|
+
/** The name. Wraps to two lines at most, then ends with "…"; a cut name shows in full in a tip on hover. */
|
|
1648
|
+
title: React$1.ReactNode;
|
|
1649
|
+
/** Top right, tabular figures: "12m", "99.98%", "240 ms". */
|
|
1650
|
+
value?: React$1.ReactNode | undefined;
|
|
1651
|
+
/** The value's colour. Default: the status's (down → danger, problem → warning, maintenance → accent, ok and
|
|
1652
|
+
* unknown → default). */
|
|
1653
|
+
valueTone?: TileTone | undefined;
|
|
1654
|
+
/** A short second line: "since 09:41", "3 of 4 checks". */
|
|
1655
|
+
meta?: React$1.ReactNode | undefined;
|
|
1656
|
+
/** Small icons at the end of the second line, each with a label. */
|
|
1657
|
+
markers?: ReadonlyArray<StatusTileMarker> | undefined;
|
|
1658
|
+
/** Makes the whole tile a link. Its name is everything the tile says, in reading order. */
|
|
1659
|
+
href?: string | undefined;
|
|
1660
|
+
/** Your router's link (e.g. `next/link`); defaults to AuraProvider's `linkComponent`, then `<a>`. */
|
|
1661
|
+
linkComponent?: React$1.ElementType | undefined;
|
|
1662
|
+
/** The status word read out after the title. Default: the locale's (Down, Problem, Maintenance, OK, No data). */
|
|
1663
|
+
statusLabel?: string | undefined;
|
|
1664
|
+
className?: string | undefined;
|
|
1665
|
+
}
|
|
1666
|
+
export interface TileGridProps extends Pick<React$1.HTMLAttributes<HTMLElement>, "id" | "style" | "lang" | "dir">, React$1.AriaAttributes, DataAttributes {
|
|
1667
|
+
/** Equal columns, responsive like Grid. Default `{ base: 2, md: 3 }` (two on phones, three from 768px). */
|
|
1668
|
+
columns?: Responsive<number> | undefined;
|
|
1669
|
+
/** Each child (and each child of a Fragment) becomes one list item; the grid is a `ul` with an 8px gap. */
|
|
1670
|
+
children?: React$1.ReactNode;
|
|
1671
|
+
className?: string | undefined;
|
|
1672
|
+
}
|
|
1673
|
+
export interface SparklineProps extends Pick<React$1.SVGAttributes<SVGSVGElement>, "id" | "style">, DataAttributes {
|
|
1674
|
+
/** The values, oldest first. `null` (or a value that isn't a finite number) is no point: the line breaks there. */
|
|
1675
|
+
data: ReadonlyArray<number | null | undefined>;
|
|
1676
|
+
/** Which points failed, by the same index as `data`. Shown only when `failures` isn't `none`. */
|
|
1677
|
+
failed?: ReadonlyArray<boolean | null | undefined> | undefined;
|
|
1678
|
+
/** How failed points show: `none` (default), `band` (a red band behind the point) or `ticks` (a red tick at the
|
|
1679
|
+
* foot). */
|
|
1680
|
+
failures?: "none" | "band" | "ticks" | undefined;
|
|
1681
|
+
/** The line's colour. Default `neutral`. */
|
|
1682
|
+
tone?: "neutral" | "accent" | "danger" | "warning" | "positive" | undefined;
|
|
1683
|
+
/** `sm` 80×24 (default), `md` 120×32. */
|
|
1684
|
+
size?: "sm" | "md" | undefined;
|
|
1685
|
+
/** The scale's ends; default the data's own lowest and highest. Give tiles the same ones to compare them. Values
|
|
1686
|
+
* beyond them are drawn at the edge. */
|
|
1687
|
+
min?: number | undefined;
|
|
1688
|
+
max?: number | undefined;
|
|
1689
|
+
/** What the line says, for screen readers ("Response time, last 24 h: 180–420 ms, 2 failures"). Without it the
|
|
1690
|
+
* sparkline is decoration and hidden from them. */
|
|
1691
|
+
label?: string | undefined;
|
|
1692
|
+
className?: string | undefined;
|
|
1693
|
+
}
|
|
1617
1694
|
/** One SVG child: element name and its attributes. */
|
|
1618
1695
|
export type IconShape = [
|
|
1619
1696
|
string,
|
|
@@ -1824,42 +1901,10 @@ export interface PageHeaderProps extends Pick<React$1.HTMLAttributes<HTMLElement
|
|
|
1824
1901
|
style?: React$1.CSSProperties | undefined;
|
|
1825
1902
|
}
|
|
1826
1903
|
export declare const PageHeader: React$1.ForwardRefExoticComponent<PageHeaderProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
1827
|
-
/**
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
1830
|
-
export declare const
|
|
1831
|
-
/** ActionBar — a bar stuck to the bottom of the screen or of a card: a status line and the form's or selection's
|
|
1832
|
-
* actions. It is `position: sticky`, so it stays in the flow at the end of its parent and never covers the last field. */
|
|
1833
|
-
export declare const ActionBar: React$1.ForwardRefExoticComponent<ActionBarProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
1834
|
-
/** Separator — a 1px `aura-border-default` rule between groups of content (4.20). Decorative by default (hidden from
|
|
1835
|
-
* screen readers); `decorative={false}` makes it a `role="separator"` that is announced. */
|
|
1836
|
-
export declare const Separator: React$1.ForwardRefExoticComponent<SeparatorProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
1837
|
-
/** A static table. Scrolls sideways inside its own box when it is wider than its container. */
|
|
1838
|
-
export declare const Table: React$1.ForwardRefExoticComponent<TableProps & React$1.RefAttributes<HTMLTableElement>>;
|
|
1839
|
-
export declare const THead: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
1840
|
-
export declare const TBody: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
1841
|
-
export declare const TFoot: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
1842
|
-
export declare const Tr: React$1.ForwardRefExoticComponent<TableRowProps & React$1.RefAttributes<HTMLTableRowElement>>;
|
|
1843
|
-
/** Header cell. `scope` defaults to `col`; pass `scope="row"` for a row header in the body. */
|
|
1844
|
-
export declare const Th: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
1845
|
-
/** Data cell. `numeric` right-aligns with tabular figures (money, counts). */
|
|
1846
|
-
export declare const Td: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
1847
|
-
/** BottomNav — a phone tab bar: icon over a short label, a count or dot, the current page marked. Fixed to the bottom,
|
|
1848
|
-
* padded for the home indicator, with a spacer of the same height in the flow so nothing sits under it. Which
|
|
1849
|
-
* breakpoints show it is decided in CSS, so the server's HTML is already right and nothing shifts on hydration. */
|
|
1850
|
-
export declare const BottomNav: React$1.ForwardRefExoticComponent<BottomNavProps & React$1.RefAttributes<HTMLElement>>;
|
|
1851
|
-
/** Min-width breakpoints in px, mirroring the aura-bp-* tokens. */
|
|
1852
|
-
export declare const breakpoints: {
|
|
1853
|
-
sm: 640;
|
|
1854
|
-
md: 768;
|
|
1855
|
-
lg: 1024;
|
|
1856
|
-
xl: 1280;
|
|
1857
|
-
};
|
|
1858
|
-
/** The widest breakpoint the window currently meets: 'base' | 'sm' | 'md' | 'lg' | 'xl'. 'lg' during server render. */
|
|
1859
|
-
export declare function useBreakpoint(): Breakpoint;
|
|
1860
|
-
/** Pick a value for the current breakpoint from { base, sm, md, lg, xl } (falls back to the next smaller one). */
|
|
1861
|
-
export declare function useResponsive<T>(value: Responsive<T>): T | undefined;
|
|
1862
|
-
export declare const Surface: React$1.ForwardRefExoticComponent<SurfaceProps & React$1.RefAttributes<HTMLElement>>;
|
|
1904
|
+
/** StatusTile (5.34, DxT Monitor S06): one monitored thing — a status icon and tint, a two-line title, a value at the
|
|
1905
|
+
* top right, a short meta line and marker icons. With `href` the whole tile is one link, named by everything it
|
|
1906
|
+
* says. Put tiles in a TileGrid. Also exported from `/server` (status word in English unless `statusLabel`). */
|
|
1907
|
+
export declare const StatusTile: React$1.ForwardRefExoticComponent<StatusTileProps & React$1.RefAttributes<HTMLElement>>;
|
|
1863
1908
|
/** Every built-in label. Function entries build the text from their arguments. */
|
|
1864
1909
|
export interface AuraStrings {
|
|
1865
1910
|
close: string;
|
|
@@ -1949,6 +1994,13 @@ export interface AuraStrings {
|
|
|
1949
1994
|
breadcrumbMore: string;
|
|
1950
1995
|
/** A Stepper step with `status: 'error'` (5.18). */
|
|
1951
1996
|
stepError: string;
|
|
1997
|
+
/** StatusTile's status words (5.34). */
|
|
1998
|
+
statusDown: string;
|
|
1999
|
+
statusProblem: string;
|
|
2000
|
+
statusMaintenance: string;
|
|
2001
|
+
statusOk: string;
|
|
2002
|
+
/** StatusTile `unknown` (5.35). */
|
|
2003
|
+
statusUnknown: string;
|
|
1952
2004
|
}
|
|
1953
2005
|
/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
|
|
1954
2006
|
* only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
|
|
@@ -1961,6 +2013,44 @@ export declare const STRINGS: {
|
|
|
1961
2013
|
th: AuraStrings;
|
|
1962
2014
|
sv: AuraStrings;
|
|
1963
2015
|
};
|
|
2016
|
+
export declare const TileGrid: React$1.ForwardRefExoticComponent<TileGridProps & React$1.RefAttributes<HTMLUListElement>>;
|
|
2017
|
+
export declare const Sparkline: React$1.ForwardRefExoticComponent<SparklineProps & React$1.RefAttributes<SVGSVGElement>>;
|
|
2018
|
+
/** AppShell — side navigation + top bar + content. The nav is fixed from lg (1024px) up and a Drawer below it.
|
|
2019
|
+
* Which one shows is decided in CSS (4.16), so the server's HTML is already right on a phone and nothing shifts on
|
|
2020
|
+
* hydration; JavaScript only opens and closes the drawer. */
|
|
2021
|
+
export declare const AppShell: React$1.ForwardRefExoticComponent<AppShellProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
2022
|
+
/** ActionBar — a bar stuck to the bottom of the screen or of a card: a status line and the form's or selection's
|
|
2023
|
+
* actions. It is `position: sticky`, so it stays in the flow at the end of its parent and never covers the last field. */
|
|
2024
|
+
export declare const ActionBar: React$1.ForwardRefExoticComponent<ActionBarProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
2025
|
+
/** Separator — a 1px `aura-border-default` rule between groups of content (4.20). Decorative by default (hidden from
|
|
2026
|
+
* screen readers); `decorative={false}` makes it a `role="separator"` that is announced. */
|
|
2027
|
+
export declare const Separator: React$1.ForwardRefExoticComponent<SeparatorProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
2028
|
+
/** A static table. Scrolls sideways inside its own box when it is wider than its container. */
|
|
2029
|
+
export declare const Table: React$1.ForwardRefExoticComponent<TableProps & React$1.RefAttributes<HTMLTableElement>>;
|
|
2030
|
+
export declare const THead: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
2031
|
+
export declare const TBody: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
2032
|
+
export declare const TFoot: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
2033
|
+
export declare const Tr: React$1.ForwardRefExoticComponent<TableRowProps & React$1.RefAttributes<HTMLTableRowElement>>;
|
|
2034
|
+
/** Header cell. `scope` defaults to `col`; pass `scope="row"` for a row header in the body. */
|
|
2035
|
+
export declare const Th: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
2036
|
+
/** Data cell. `numeric` right-aligns with tabular figures (money, counts). */
|
|
2037
|
+
export declare const Td: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
2038
|
+
/** BottomNav — a phone tab bar: icon over a short label, a count or dot, the current page marked. Fixed to the bottom,
|
|
2039
|
+
* padded for the home indicator, with a spacer of the same height in the flow so nothing sits under it. Which
|
|
2040
|
+
* breakpoints show it is decided in CSS, so the server's HTML is already right and nothing shifts on hydration. */
|
|
2041
|
+
export declare const BottomNav: React$1.ForwardRefExoticComponent<BottomNavProps & React$1.RefAttributes<HTMLElement>>;
|
|
2042
|
+
/** Min-width breakpoints in px, mirroring the aura-bp-* tokens. */
|
|
2043
|
+
export declare const breakpoints: {
|
|
2044
|
+
sm: 640;
|
|
2045
|
+
md: 768;
|
|
2046
|
+
lg: 1024;
|
|
2047
|
+
xl: 1280;
|
|
2048
|
+
};
|
|
2049
|
+
/** The widest breakpoint the window currently meets: 'base' | 'sm' | 'md' | 'lg' | 'xl'. 'lg' during server render. */
|
|
2050
|
+
export declare function useBreakpoint(): Breakpoint;
|
|
2051
|
+
/** Pick a value for the current breakpoint from { base, sm, md, lg, xl } (falls back to the next smaller one). */
|
|
2052
|
+
export declare function useResponsive<T>(value: Responsive<T>): T | undefined;
|
|
2053
|
+
export declare const Surface: React$1.ForwardRefExoticComponent<SurfaceProps & React$1.RefAttributes<HTMLElement>>;
|
|
1964
2054
|
/** What useAuraLocale returns. `locale` and `calendar` are null outside an AuraProvider. */
|
|
1965
2055
|
export interface AuraLocaleValue {
|
|
1966
2056
|
locale: "th" | "en" | "sv" | null;
|
package/dist/index.d.ts
CHANGED
|
@@ -1214,6 +1214,10 @@ export interface AppShellProps {
|
|
|
1214
1214
|
* as when there is no `header`: from lg up it is hidden and `--aura-shell-bar-height` is 0. For apps whose phone
|
|
1215
1215
|
* pages have a top bar (brand, avatar) and whose desktop pages don't. Default: the bar shows at every width. */
|
|
1216
1216
|
headerHideFrom?: "lg" | undefined;
|
|
1217
|
+
/** 5.35 (DxT Monitor #13): below 1024px the top bar slides up while the page scrolls down and comes back on the way
|
|
1218
|
+
* up, near the top, and when focus enters it; `--aura-shell-bar-height` is 0 while it is away, so headers pinned
|
|
1219
|
+
* under it follow. No motion with reduced motion. Default false. */
|
|
1220
|
+
headerHideOnScroll?: boolean | undefined;
|
|
1217
1221
|
children?: React$1.ReactNode | undefined;
|
|
1218
1222
|
navLabel?: string | undefined;
|
|
1219
1223
|
menuLabel?: string | undefined;
|
|
@@ -1324,6 +1328,10 @@ export interface ActionBarProps {
|
|
|
1324
1328
|
* parent, so they never cover the last field. Make it the last child of the form or card it belongs to: like any
|
|
1325
1329
|
* `position: sticky` element it sticks only while that parent is on screen. */
|
|
1326
1330
|
position?: "viewport" | "container" | undefined;
|
|
1331
|
+
/** 5.35 (DxT Monitor #14): while this bar is on the page, a BottomNav (and its spacer) is hidden and the bar takes the
|
|
1332
|
+
* bottom edge — for a page whose own actions (Acknowledge, Visit site) replace the tab bar. Any element can do the
|
|
1333
|
+
* same with the `data-aura-hide-bottomnav` attribute. */
|
|
1334
|
+
hidesBottomNav?: boolean | undefined;
|
|
1327
1335
|
/** Bulk actions: the number of selected rows. Shows "N selected" in the status; at 0 the bar hides (its live region
|
|
1328
1336
|
* stays, so the next selection is announced) and its actions leave the tab order. */
|
|
1329
1337
|
selected?: number | undefined;
|
|
@@ -1365,6 +1373,10 @@ export interface BottomNavProps {
|
|
|
1365
1373
|
linkComponent?: React$1.ElementType | undefined;
|
|
1366
1374
|
/** Hidden from this breakpoint up, in CSS (so the server's HTML is right). Default `lg` (1024px); `false` never hides. */
|
|
1367
1375
|
hideFrom?: "md" | "lg" | "xl" | false | undefined;
|
|
1376
|
+
/** 5.35 (DxT Monitor #14): slides down out of view while the page scrolls down and comes back on the way up, near the
|
|
1377
|
+
* top, and when focus enters it. Viewport ActionBars and toasts follow it down. Default false. To keep it away on a
|
|
1378
|
+
* page with its own bottom bar, see ActionBar `hidesBottomNav` (or `data-aura-hide-bottomnav` on your own bar). */
|
|
1379
|
+
hideOnScroll?: boolean | undefined;
|
|
1368
1380
|
className?: string | undefined;
|
|
1369
1381
|
}
|
|
1370
1382
|
export interface StatChange {
|
|
@@ -1614,6 +1626,71 @@ export interface Theme {
|
|
|
1614
1626
|
/** CSS overriding the tokens. No selector: the whole page. A selector (".tenant-acme") scopes it. Load after aura.css. */
|
|
1615
1627
|
css(selector?: string): string;
|
|
1616
1628
|
}
|
|
1629
|
+
/** A monitored thing's state on a StatusTile. */
|
|
1630
|
+
export type StatusTileStatus = "down" | "problem" | "maintenance" | "ok" | "unknown";
|
|
1631
|
+
/** A colour for a tile's value or a marker: `danger`, `warning`, `accent` (violet), `neutral` (grey) or `default`
|
|
1632
|
+
* (the text colour). */
|
|
1633
|
+
export type TileTone = "danger" | "warning" | "accent" | "neutral" | "default";
|
|
1634
|
+
/** A small icon at the end of a StatusTile's second line ("SSL expires soon", "Muted"). */
|
|
1635
|
+
export interface StatusTileMarker {
|
|
1636
|
+
icon: IconInput;
|
|
1637
|
+
/** What it means. Read with the tile's name and shown as a tip on hover (a mouse only: on a phone, say it on the
|
|
1638
|
+
* detail page too). */
|
|
1639
|
+
label: string;
|
|
1640
|
+
/** Default `neutral`. */
|
|
1641
|
+
tone?: TileTone | undefined;
|
|
1642
|
+
}
|
|
1643
|
+
export interface StatusTileProps extends Pick<React$1.HTMLAttributes<HTMLElement>, "id" | "style" | "lang" | "dir">, React$1.AriaAttributes, DataAttributes {
|
|
1644
|
+
/** down (red), problem (amber), maintenance (violet), ok (grey) or unknown (5.35: no data yet — a dashed circle on
|
|
1645
|
+
* the plain surface). Each has its own icon too, so colour is never the only sign. */
|
|
1646
|
+
status: StatusTileStatus;
|
|
1647
|
+
/** The name. Wraps to two lines at most, then ends with "…"; a cut name shows in full in a tip on hover. */
|
|
1648
|
+
title: React$1.ReactNode;
|
|
1649
|
+
/** Top right, tabular figures: "12m", "99.98%", "240 ms". */
|
|
1650
|
+
value?: React$1.ReactNode | undefined;
|
|
1651
|
+
/** The value's colour. Default: the status's (down → danger, problem → warning, maintenance → accent, ok and
|
|
1652
|
+
* unknown → default). */
|
|
1653
|
+
valueTone?: TileTone | undefined;
|
|
1654
|
+
/** A short second line: "since 09:41", "3 of 4 checks". */
|
|
1655
|
+
meta?: React$1.ReactNode | undefined;
|
|
1656
|
+
/** Small icons at the end of the second line, each with a label. */
|
|
1657
|
+
markers?: ReadonlyArray<StatusTileMarker> | undefined;
|
|
1658
|
+
/** Makes the whole tile a link. Its name is everything the tile says, in reading order. */
|
|
1659
|
+
href?: string | undefined;
|
|
1660
|
+
/** Your router's link (e.g. `next/link`); defaults to AuraProvider's `linkComponent`, then `<a>`. */
|
|
1661
|
+
linkComponent?: React$1.ElementType | undefined;
|
|
1662
|
+
/** The status word read out after the title. Default: the locale's (Down, Problem, Maintenance, OK, No data). */
|
|
1663
|
+
statusLabel?: string | undefined;
|
|
1664
|
+
className?: string | undefined;
|
|
1665
|
+
}
|
|
1666
|
+
export interface TileGridProps extends Pick<React$1.HTMLAttributes<HTMLElement>, "id" | "style" | "lang" | "dir">, React$1.AriaAttributes, DataAttributes {
|
|
1667
|
+
/** Equal columns, responsive like Grid. Default `{ base: 2, md: 3 }` (two on phones, three from 768px). */
|
|
1668
|
+
columns?: Responsive<number> | undefined;
|
|
1669
|
+
/** Each child (and each child of a Fragment) becomes one list item; the grid is a `ul` with an 8px gap. */
|
|
1670
|
+
children?: React$1.ReactNode;
|
|
1671
|
+
className?: string | undefined;
|
|
1672
|
+
}
|
|
1673
|
+
export interface SparklineProps extends Pick<React$1.SVGAttributes<SVGSVGElement>, "id" | "style">, DataAttributes {
|
|
1674
|
+
/** The values, oldest first. `null` (or a value that isn't a finite number) is no point: the line breaks there. */
|
|
1675
|
+
data: ReadonlyArray<number | null | undefined>;
|
|
1676
|
+
/** Which points failed, by the same index as `data`. Shown only when `failures` isn't `none`. */
|
|
1677
|
+
failed?: ReadonlyArray<boolean | null | undefined> | undefined;
|
|
1678
|
+
/** How failed points show: `none` (default), `band` (a red band behind the point) or `ticks` (a red tick at the
|
|
1679
|
+
* foot). */
|
|
1680
|
+
failures?: "none" | "band" | "ticks" | undefined;
|
|
1681
|
+
/** The line's colour. Default `neutral`. */
|
|
1682
|
+
tone?: "neutral" | "accent" | "danger" | "warning" | "positive" | undefined;
|
|
1683
|
+
/** `sm` 80×24 (default), `md` 120×32. */
|
|
1684
|
+
size?: "sm" | "md" | undefined;
|
|
1685
|
+
/** The scale's ends; default the data's own lowest and highest. Give tiles the same ones to compare them. Values
|
|
1686
|
+
* beyond them are drawn at the edge. */
|
|
1687
|
+
min?: number | undefined;
|
|
1688
|
+
max?: number | undefined;
|
|
1689
|
+
/** What the line says, for screen readers ("Response time, last 24 h: 180–420 ms, 2 failures"). Without it the
|
|
1690
|
+
* sparkline is decoration and hidden from them. */
|
|
1691
|
+
label?: string | undefined;
|
|
1692
|
+
className?: string | undefined;
|
|
1693
|
+
}
|
|
1617
1694
|
/** One SVG child: element name and its attributes. */
|
|
1618
1695
|
export type IconShape = [
|
|
1619
1696
|
string,
|
|
@@ -1824,42 +1901,10 @@ export interface PageHeaderProps extends Pick<React$1.HTMLAttributes<HTMLElement
|
|
|
1824
1901
|
style?: React$1.CSSProperties | undefined;
|
|
1825
1902
|
}
|
|
1826
1903
|
export declare const PageHeader: React$1.ForwardRefExoticComponent<PageHeaderProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
1827
|
-
/**
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
1830
|
-
export declare const
|
|
1831
|
-
/** ActionBar — a bar stuck to the bottom of the screen or of a card: a status line and the form's or selection's
|
|
1832
|
-
* actions. It is `position: sticky`, so it stays in the flow at the end of its parent and never covers the last field. */
|
|
1833
|
-
export declare const ActionBar: React$1.ForwardRefExoticComponent<ActionBarProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
1834
|
-
/** Separator — a 1px `aura-border-default` rule between groups of content (4.20). Decorative by default (hidden from
|
|
1835
|
-
* screen readers); `decorative={false}` makes it a `role="separator"` that is announced. */
|
|
1836
|
-
export declare const Separator: React$1.ForwardRefExoticComponent<SeparatorProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
1837
|
-
/** A static table. Scrolls sideways inside its own box when it is wider than its container. */
|
|
1838
|
-
export declare const Table: React$1.ForwardRefExoticComponent<TableProps & React$1.RefAttributes<HTMLTableElement>>;
|
|
1839
|
-
export declare const THead: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
1840
|
-
export declare const TBody: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
1841
|
-
export declare const TFoot: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
1842
|
-
export declare const Tr: React$1.ForwardRefExoticComponent<TableRowProps & React$1.RefAttributes<HTMLTableRowElement>>;
|
|
1843
|
-
/** Header cell. `scope` defaults to `col`; pass `scope="row"` for a row header in the body. */
|
|
1844
|
-
export declare const Th: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
1845
|
-
/** Data cell. `numeric` right-aligns with tabular figures (money, counts). */
|
|
1846
|
-
export declare const Td: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
1847
|
-
/** BottomNav — a phone tab bar: icon over a short label, a count or dot, the current page marked. Fixed to the bottom,
|
|
1848
|
-
* padded for the home indicator, with a spacer of the same height in the flow so nothing sits under it. Which
|
|
1849
|
-
* breakpoints show it is decided in CSS, so the server's HTML is already right and nothing shifts on hydration. */
|
|
1850
|
-
export declare const BottomNav: React$1.ForwardRefExoticComponent<BottomNavProps & React$1.RefAttributes<HTMLElement>>;
|
|
1851
|
-
/** Min-width breakpoints in px, mirroring the aura-bp-* tokens. */
|
|
1852
|
-
export declare const breakpoints: {
|
|
1853
|
-
sm: 640;
|
|
1854
|
-
md: 768;
|
|
1855
|
-
lg: 1024;
|
|
1856
|
-
xl: 1280;
|
|
1857
|
-
};
|
|
1858
|
-
/** The widest breakpoint the window currently meets: 'base' | 'sm' | 'md' | 'lg' | 'xl'. 'lg' during server render. */
|
|
1859
|
-
export declare function useBreakpoint(): Breakpoint;
|
|
1860
|
-
/** Pick a value for the current breakpoint from { base, sm, md, lg, xl } (falls back to the next smaller one). */
|
|
1861
|
-
export declare function useResponsive<T>(value: Responsive<T>): T | undefined;
|
|
1862
|
-
export declare const Surface: React$1.ForwardRefExoticComponent<SurfaceProps & React$1.RefAttributes<HTMLElement>>;
|
|
1904
|
+
/** StatusTile (5.34, DxT Monitor S06): one monitored thing — a status icon and tint, a two-line title, a value at the
|
|
1905
|
+
* top right, a short meta line and marker icons. With `href` the whole tile is one link, named by everything it
|
|
1906
|
+
* says. Put tiles in a TileGrid. Also exported from `/server` (status word in English unless `statusLabel`). */
|
|
1907
|
+
export declare const StatusTile: React$1.ForwardRefExoticComponent<StatusTileProps & React$1.RefAttributes<HTMLElement>>;
|
|
1863
1908
|
/** Every built-in label. Function entries build the text from their arguments. */
|
|
1864
1909
|
export interface AuraStrings {
|
|
1865
1910
|
close: string;
|
|
@@ -1949,6 +1994,13 @@ export interface AuraStrings {
|
|
|
1949
1994
|
breadcrumbMore: string;
|
|
1950
1995
|
/** A Stepper step with `status: 'error'` (5.18). */
|
|
1951
1996
|
stepError: string;
|
|
1997
|
+
/** StatusTile's status words (5.34). */
|
|
1998
|
+
statusDown: string;
|
|
1999
|
+
statusProblem: string;
|
|
2000
|
+
statusMaintenance: string;
|
|
2001
|
+
statusOk: string;
|
|
2002
|
+
/** StatusTile `unknown` (5.35). */
|
|
2003
|
+
statusUnknown: string;
|
|
1952
2004
|
}
|
|
1953
2005
|
/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
|
|
1954
2006
|
* only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
|
|
@@ -1961,6 +2013,44 @@ export declare const STRINGS: {
|
|
|
1961
2013
|
th: AuraStrings;
|
|
1962
2014
|
sv: AuraStrings;
|
|
1963
2015
|
};
|
|
2016
|
+
export declare const TileGrid: React$1.ForwardRefExoticComponent<TileGridProps & React$1.RefAttributes<HTMLUListElement>>;
|
|
2017
|
+
export declare const Sparkline: React$1.ForwardRefExoticComponent<SparklineProps & React$1.RefAttributes<SVGSVGElement>>;
|
|
2018
|
+
/** AppShell — side navigation + top bar + content. The nav is fixed from lg (1024px) up and a Drawer below it.
|
|
2019
|
+
* Which one shows is decided in CSS (4.16), so the server's HTML is already right on a phone and nothing shifts on
|
|
2020
|
+
* hydration; JavaScript only opens and closes the drawer. */
|
|
2021
|
+
export declare const AppShell: React$1.ForwardRefExoticComponent<AppShellProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
2022
|
+
/** ActionBar — a bar stuck to the bottom of the screen or of a card: a status line and the form's or selection's
|
|
2023
|
+
* actions. It is `position: sticky`, so it stays in the flow at the end of its parent and never covers the last field. */
|
|
2024
|
+
export declare const ActionBar: React$1.ForwardRefExoticComponent<ActionBarProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
2025
|
+
/** Separator — a 1px `aura-border-default` rule between groups of content (4.20). Decorative by default (hidden from
|
|
2026
|
+
* screen readers); `decorative={false}` makes it a `role="separator"` that is announced. */
|
|
2027
|
+
export declare const Separator: React$1.ForwardRefExoticComponent<SeparatorProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
2028
|
+
/** A static table. Scrolls sideways inside its own box when it is wider than its container. */
|
|
2029
|
+
export declare const Table: React$1.ForwardRefExoticComponent<TableProps & React$1.RefAttributes<HTMLTableElement>>;
|
|
2030
|
+
export declare const THead: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
2031
|
+
export declare const TBody: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
2032
|
+
export declare const TFoot: React$1.ForwardRefExoticComponent<TableSectionProps & React$1.RefAttributes<HTMLTableSectionElement>>;
|
|
2033
|
+
export declare const Tr: React$1.ForwardRefExoticComponent<TableRowProps & React$1.RefAttributes<HTMLTableRowElement>>;
|
|
2034
|
+
/** Header cell. `scope` defaults to `col`; pass `scope="row"` for a row header in the body. */
|
|
2035
|
+
export declare const Th: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
2036
|
+
/** Data cell. `numeric` right-aligns with tabular figures (money, counts). */
|
|
2037
|
+
export declare const Td: React$1.ForwardRefExoticComponent<TableCellProps & React$1.RefAttributes<HTMLTableCellElement>>;
|
|
2038
|
+
/** BottomNav — a phone tab bar: icon over a short label, a count or dot, the current page marked. Fixed to the bottom,
|
|
2039
|
+
* padded for the home indicator, with a spacer of the same height in the flow so nothing sits under it. Which
|
|
2040
|
+
* breakpoints show it is decided in CSS, so the server's HTML is already right and nothing shifts on hydration. */
|
|
2041
|
+
export declare const BottomNav: React$1.ForwardRefExoticComponent<BottomNavProps & React$1.RefAttributes<HTMLElement>>;
|
|
2042
|
+
/** Min-width breakpoints in px, mirroring the aura-bp-* tokens. */
|
|
2043
|
+
export declare const breakpoints: {
|
|
2044
|
+
sm: 640;
|
|
2045
|
+
md: 768;
|
|
2046
|
+
lg: 1024;
|
|
2047
|
+
xl: 1280;
|
|
2048
|
+
};
|
|
2049
|
+
/** The widest breakpoint the window currently meets: 'base' | 'sm' | 'md' | 'lg' | 'xl'. 'lg' during server render. */
|
|
2050
|
+
export declare function useBreakpoint(): Breakpoint;
|
|
2051
|
+
/** Pick a value for the current breakpoint from { base, sm, md, lg, xl } (falls back to the next smaller one). */
|
|
2052
|
+
export declare function useResponsive<T>(value: Responsive<T>): T | undefined;
|
|
2053
|
+
export declare const Surface: React$1.ForwardRefExoticComponent<SurfaceProps & React$1.RefAttributes<HTMLElement>>;
|
|
1964
2054
|
/** What useAuraLocale returns. `locale` and `calendar` are null outside an AuraProvider. */
|
|
1965
2055
|
export interface AuraLocaleValue {
|
|
1966
2056
|
locale: "th" | "en" | "sv" | null;
|
package/dist/locales/sv.cjs
CHANGED
|
@@ -148,6 +148,11 @@ var sv = {
|
|
|
148
148
|
},
|
|
149
149
|
breadcrumbMore: "Visa hela s\xF6kv\xE4gen",
|
|
150
150
|
stepError: "har fel",
|
|
151
|
+
statusDown: "Nere",
|
|
152
|
+
statusProblem: "Problem",
|
|
153
|
+
statusMaintenance: "Underh\xE5ll",
|
|
154
|
+
statusOk: "OK",
|
|
155
|
+
statusUnknown: "Ingen data",
|
|
151
156
|
accepts: function(list, max) {
|
|
152
157
|
return [list, max && "h\xF6gst " + max + " per fil"].filter(Boolean).join(", ");
|
|
153
158
|
}
|
package/dist/locales/sv.d.cts
CHANGED
|
@@ -89,6 +89,13 @@ export interface AuraStrings {
|
|
|
89
89
|
breadcrumbMore: string;
|
|
90
90
|
/** A Stepper step with `status: 'error'` (5.18). */
|
|
91
91
|
stepError: string;
|
|
92
|
+
/** StatusTile's status words (5.34). */
|
|
93
|
+
statusDown: string;
|
|
94
|
+
statusProblem: string;
|
|
95
|
+
statusMaintenance: string;
|
|
96
|
+
statusOk: string;
|
|
97
|
+
/** StatusTile `unknown` (5.35). */
|
|
98
|
+
statusUnknown: string;
|
|
92
99
|
}
|
|
93
100
|
/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
|
|
94
101
|
* only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
|
package/dist/locales/sv.d.ts
CHANGED
|
@@ -89,6 +89,13 @@ export interface AuraStrings {
|
|
|
89
89
|
breadcrumbMore: string;
|
|
90
90
|
/** A Stepper step with `status: 'error'` (5.18). */
|
|
91
91
|
stepError: string;
|
|
92
|
+
/** StatusTile's status words (5.34). */
|
|
93
|
+
statusDown: string;
|
|
94
|
+
statusProblem: string;
|
|
95
|
+
statusMaintenance: string;
|
|
96
|
+
statusOk: string;
|
|
97
|
+
/** StatusTile `unknown` (5.35). */
|
|
98
|
+
statusUnknown: string;
|
|
92
99
|
}
|
|
93
100
|
/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
|
|
94
101
|
* only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
|
package/dist/locales/th.cjs
CHANGED
|
@@ -148,6 +148,11 @@ var th = {
|
|
|
148
148
|
},
|
|
149
149
|
breadcrumbMore: "\u0E41\u0E2A\u0E14\u0E07\u0E40\u0E2A\u0E49\u0E19\u0E17\u0E32\u0E07\u0E17\u0E31\u0E49\u0E07\u0E2B\u0E21\u0E14",
|
|
150
150
|
stepError: "\u0E21\u0E35\u0E02\u0E49\u0E2D\u0E1C\u0E34\u0E14\u0E1E\u0E25\u0E32\u0E14",
|
|
151
|
+
statusDown: "\u0E25\u0E48\u0E21",
|
|
152
|
+
statusProblem: "\u0E21\u0E35\u0E1B\u0E31\u0E0D\u0E2B\u0E32",
|
|
153
|
+
statusMaintenance: "\u0E1B\u0E34\u0E14\u0E1B\u0E23\u0E31\u0E1A\u0E1B\u0E23\u0E38\u0E07",
|
|
154
|
+
statusOk: "\u0E1B\u0E01\u0E15\u0E34",
|
|
155
|
+
statusUnknown: "\u0E22\u0E31\u0E07\u0E44\u0E21\u0E48\u0E21\u0E35\u0E02\u0E49\u0E2D\u0E21\u0E39\u0E25",
|
|
151
156
|
accepts: function(list, max) {
|
|
152
157
|
return [list, max && "\u0E44\u0E21\u0E48\u0E40\u0E01\u0E34\u0E19 " + max + " \u0E15\u0E48\u0E2D\u0E44\u0E1F\u0E25\u0E4C"].filter(Boolean).join(" \xB7 ");
|
|
153
158
|
}
|
package/dist/locales/th.d.cts
CHANGED
|
@@ -89,6 +89,13 @@ export interface AuraStrings {
|
|
|
89
89
|
breadcrumbMore: string;
|
|
90
90
|
/** A Stepper step with `status: 'error'` (5.18). */
|
|
91
91
|
stepError: string;
|
|
92
|
+
/** StatusTile's status words (5.34). */
|
|
93
|
+
statusDown: string;
|
|
94
|
+
statusProblem: string;
|
|
95
|
+
statusMaintenance: string;
|
|
96
|
+
statusOk: string;
|
|
97
|
+
/** StatusTile `unknown` (5.35). */
|
|
98
|
+
statusUnknown: string;
|
|
92
99
|
}
|
|
93
100
|
/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
|
|
94
101
|
* only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
|
package/dist/locales/th.d.ts
CHANGED
|
@@ -89,6 +89,13 @@ export interface AuraStrings {
|
|
|
89
89
|
breadcrumbMore: string;
|
|
90
90
|
/** A Stepper step with `status: 'error'` (5.18). */
|
|
91
91
|
stepError: string;
|
|
92
|
+
/** StatusTile's status words (5.34). */
|
|
93
|
+
statusDown: string;
|
|
94
|
+
statusProblem: string;
|
|
95
|
+
statusMaintenance: string;
|
|
96
|
+
statusOk: string;
|
|
97
|
+
/** StatusTile `unknown` (5.35). */
|
|
98
|
+
statusUnknown: string;
|
|
92
99
|
}
|
|
93
100
|
/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
|
|
94
101
|
* only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
|