Skip to main content

day_pieces/
lib.rs

1// Copyright © The Daybrite Project
2// SPDX-License-Identifier: MPL-2.0
3
4//! day-pieces: the built-in piece library (DESIGN.md §5.3).
5//!
6//! Every constructor is a plain function returning a piece value; builder methods configure;
7//! `build` runs once. Dynamic attributes become seeded bindings writing sparse typed patches
8//! through the thread-local tree.
9//!
10//! The vocabulary is split across sibling modules (one logical group each) and re-exported here,
11//! so the public API stays flat (`day_pieces::button`, `day_pieces::stack`, …) regardless of
12//! which module a piece is defined in.
13
14day_reactive::tls_root! {
15    menus: crate::menus::TlsGroupSlots,
16    nav: crate::nav::TlsGroupSlots,
17}
18
19pub mod async_image;
20pub mod colorpicker;
21pub mod combobox;
22pub mod datetime;
23pub mod pager;
24pub mod pullrefresh;
25pub mod searchfield;
26pub mod stepper;
27pub use async_image::{AsyncImage, AsyncImageBuilder, async_image};
28pub mod render;
29
30// The dynamic piece registry (docs/lite.md §4 in https://github.com/daybrite/day-lite): drive
31// pieces by name with loosely-typed values, the surface interpreted languages (day-lite) build
32// UIs through.
33#[cfg(feature = "dyn-registry")]
34pub mod dynreg;
35/// `#[day_pieces::builder(FooBuilder)]`: a piece's builder trait, generated from its inherent
36/// impl (docs/api-style.md "Typed builders and erasure").
37pub use day_core::{Dimension, ElementId, Grow, IntoElementKey, id};
38pub use day_macros::builder;
39
40// The piece vocabulary: one logical group per module, re-exported flat (see each module's docs).
41mod canvas;
42mod commands;
43pub use commands::Command;
44mod containers;
45mod decorators;
46mod dialogs;
47mod file_access;
48pub use file_access::FileAccess;
49#[cfg(feature = "conformance")]
50pub mod conformance;
51mod forms;
52mod image;
53mod inputs;
54/// A drop destination (docs/drag-and-drop.md): what [`Decorate::drop_target`] takes.
55pub use day_spec::transfer::Target as DropTarget;
56mod inspector;
57mod leaves;
58mod markdown;
59mod menus;
60mod nav;
61mod shapes;
62mod sources;
63mod split;
64mod status;
65mod structure;
66mod tabs;
67mod tokens;
68mod toolbar;
69pub use tabs::*;
70pub use tokens::*;
71
72pub use canvas::*;
73pub use containers::*;
74pub use decorators::*;
75pub use dialogs::*;
76pub use forms::*;
77pub use image::*;
78pub use inputs::*;
79pub use inspector::*;
80pub use leaves::*;
81pub use markdown::*;
82pub use menus::*;
83pub use nav::*;
84pub use shapes::*;
85pub use sources::*;
86pub use split::*;
87pub use status::{StatusItem, StatusItemHandle, status_item};
88pub use structure::*;
89// The ambient environment and the `Ambient` state trait (docs/state.md) live in day-core, so an
90// app's `*-core` crate (which depends on day-core but not on day-pieces) can `impl Ambient`
91// for its view-model. Re-exported here so `day_pieces::environment` and the prelude are unchanged.
92pub use day_core::{Ambient, app_environment, environment, focused_environment, with_environment};
93// Canvas export (docs/canvas.md "Exporting"): what this toolkit can render a `Drawing` to.
94pub use day_core::{CanvasExports, RenderBitmap, RenderPdf, canvas_exports};
95pub use toolbar::*;
96
97pub use colorpicker::{ColorPicker, ColorPickerBuilder, PickerIdiom, color_picker};
98pub use combobox::{ComboBox, ComboBoxBuilder, combo_box};
99pub use datetime::{
100    DatePicker, DatePickerBuilder, DayDate, DayTime, TimePicker, TimePickerBuilder, date_picker,
101    time_picker,
102};
103pub use day_localization::NumberFormat;
104pub use pager::{Pager, PagerBuilder, PagerState, pager};
105pub use pullrefresh::{PullRefresh, PullRefreshBuilder, pull_to_refresh};
106pub use searchfield::{SearchField, SearchFieldBuilder, search_field};
107pub use stepper::{
108    NumberField, NumberFieldBuilder, Stepper, StepperBuilder, StepperIdiom, number_field, stepper,
109};
110
111pub mod prelude {
112    pub use crate::colorpicker::{ColorPicker, ColorPickerBuilder, PickerIdiom, color_picker};
113    pub use crate::combobox::{ComboBox, ComboBoxBuilder, combo_box};
114    pub use crate::datetime::{
115        DatePicker, DatePickerBuilder, DayDate, DayTime, TimePicker, TimePickerBuilder,
116        date_picker, time_picker,
117    };
118    pub use crate::pager::{Pager, PagerBuilder, PagerState, pager};
119    pub use crate::pullrefresh::{PullRefresh, PullRefreshBuilder, pull_to_refresh};
120    pub use crate::searchfield::{SearchField, SearchFieldBuilder, search_field};
121    pub use crate::stepper::{
122        NumberField, NumberFieldBuilder, Stepper, StepperBuilder, StepperIdiom, number_field,
123        stepper,
124    };
125    pub use crate::{AsyncImage, AsyncImageBuilder, async_image};
126    pub use day_localization::NumberFormat;
127
128    pub use crate::{DocumentTabs, TabActions, TabSet, document_tabs};
129    pub use day_core::{ElementId, IntoElementKey, id};
130    // Model-driven rows (docs/model.md): the store-as-RowSource surface.
131    pub use crate::TextStyle;
132    pub use crate::ToolbarEntry;
133    pub use crate::routes;
134    pub use crate::{
135        A11yBuilder, Alert, Ambient, BackRequest, BackResponse, Binding, ButtonBuilder,
136        ColumnBuilder, Command, Confirm, ContentList, Corner, Cover, Decorate, Decorated, Delete,
137        Drag, Draw, FileAccess, FileUrl, Form, FormSection, Grid, GridRow, HAlign, Inspector,
138        IntoFocusBinding, IntoFraction, IntoImageSource, IntoReactive, IntoText, ItemSlot,
139        LabelBuilder, Labeled, List, ListItem, ListItemBuilder, Loaded, Markdown, MarkdownBuilder,
140        MarkdownCode, MenuButton, MenuButtonBuilder, MenuContent, MenuEntry, Modifier, Move,
141        NativeRef, Nav, NavContent, NavDrag, NavDrop, NavItem, NavStack, NavStyle, OpenFile,
142        OpenFiles, OpenFolder, Pan, PathBuilder, Pinch, ProgressBuilder, Prompt, Reactive, Reorder,
143        ReorderVerdict, Rotate, Route, RoutePath, RowBuilder, RowFit, SaveFile, Search,
144        SearchReveal, Sections, SelectedText, ShapeKind, ShapePiece, Share, ShareAction,
145        StatusItem, Surface, SwipeAction, TextBuilder, VAlign, VectorWeight, When, ZStack,
146        adaptive, alert, app_environment, app_menu, arc, button, canvas, capsule, circle, column,
147        confirm, cover, current_route, divider, dock_menu, each, ellipse, environment,
148        focused_environment, form, grid, grid_row, image, inspector, item, items, keyed, label,
149        labeled, line, link, list, list_item, load, markdown, menu_button, menu_item, menu_role,
150        menu_separator, nav, nav_back, nav_items, nav_link, nav_link_to, nav_stack, navigate,
151        navigate_to, open_file, open_files, open_folder, open_link, picker, picker_optional,
152        polygon, progress, prompt, rectangle, rounded_rectangle, route, route_param, route_params,
153        row, save_file, scroll, section, secure_field, segment, shape, shape_group, shape_group_fn,
154        share_action, share_support, slider, spacer, spinner, split, status_item, sub_menu,
155        swipe_action, switch, text_area, text_field, toggle, toolbar_button, toolbar_label,
156        toolbar_menu, toolbar_segmented, toolbar_separator, toolbar_toggle, vector, when,
157        with_environment, zstack,
158    };
159    pub use crate::{DropTarget, InteractionState};
160    pub use crate::{Radius, Space, TextPreset};
161    // Canvas export (docs/canvas.md "Exporting"): record a drawing once, render it to a bitmap
162    // or a PDF through the toolkit's own painter, and ask what this target can do first.
163    pub use crate::{CanvasExports, Drawing, PdfDocument, canvas_exports};
164    // The color a view is drawn in (docs/color.md): a fixed `Color`, a light/dark pair or a
165    // platform role, accepted by every color parameter; `day::resolve(ink)` reads one.
166    pub use day_spec::{ExportError, Ink, Palette, SystemColor};
167    // The hierarchical tree (docs/tree.md): the piece, its sources, and its verdict enum.
168    pub use crate::{
169        Branches, MoveVerdict, NodeSource, TreeBuilder, TreeConn, TreePiece, branches, tree,
170    };
171    // Typed builder traits (docs/api-style.md "Typed builders and erasure"): each piece's own
172    // builders, forwarded through `Decorated` so they still chain after a generic modifier. A
173    // piece implements exactly one, so the names they share (`title`, `style`, `align`, …) never
174    // become ambiguous at a call site. (`LabelBuilder`, `ButtonBuilder`, `ColumnBuilder` and
175    // `RowBuilder` sit in the list above, in alphabetical company.)
176    pub use crate::{
177        AdaptiveBuilder, CoverBuilder, DividerBuilder, FormSectionBuilder, GridBuilder,
178        GridRowBuilder, ImageBuilder, InspectorBuilder, LanesBuilder, ListBuilder, NavBuilder,
179        NavStackBuilder, PickerBuilder, ScrollBuilder, ShapePieceBuilder, SliderBuilder,
180        SplitBuilder, TextAreaBuilder, TextFieldBuilder, ToggleBuilder, VectorBuilder, WhenBuilder,
181        ZStackBuilder,
182    };
183    #[cfg(feature = "model")]
184    pub use crate::{ModelSlot, Rows, StoreRows, StoreTree, StoreTrees};
185    pub use crate::{Picker, TextArea};
186    pub use day_core::{
187        Alignment, AnyPiece, BuildCx, Dimension, Either, Grow, Piece, PieceFn, PieceSeq, RNode,
188        ScrollTarget, announce, announce_urgent, invalidate_size, open_url, piece_fn,
189        with_animation,
190    };
191    pub use day_geometry::{
192        Affine, Angle, Animatable, Color, Insets, Point, Rect, Size, Transform,
193    };
194    pub use day_reactive::{
195        AnyBinding, Effect, Memo, Scope, Setter, Signal, Trigger, batch, bind, untrack, watch,
196    };
197    // `Nav::presentation` takes one (docs/size-classes.md); apps that leave the
198    // presentation automatic never name it.
199    pub use day_spec::props::NavPresentation;
200    pub use day_spec::props::PickerStyle;
201    pub use day_spec::props::RowHeight;
202    // Lists and scroll views (docs/list.md, docs/scroll.md): where a row lands, what a scroll
203    // view does with the keyboard, and where user-driven scrolling stands.
204    pub use crate::{Lanes, RowTarget, lanes};
205    pub use day_spec::props::{KeyboardDismiss, KeyboardTaps};
206    pub use day_spec::props::{PaneEdge, SplitAxis};
207    pub use day_spec::props::{TextAlign, Truncation};
208    pub use day_spec::{AnimSpec, Curve};
209    pub use day_spec::{AssetName, FontFamily, ImageName};
210    pub use day_spec::{DragAxis, DragPhase, Edges, GestureKind};
211    // Raw contacts and the input kind (docs/gestures.md "Touches", "Input kind").
212    pub use day_spec::{PointerKind, Touch, TouchPhase};
213    pub use day_spec::{RowAlign, ScrollPhase};
214    // Text entry (docs/textfield.md): what a field collects and what its action key says.
215    pub use day_spec::{
216        BlendMode, Border, ConicGradient, Corners, DrawOp, LinearGradient, Paint, RadialGradient,
217        Shadow, Shape, TextAnchor, TextVAlign, UnitPoint,
218    };
219    pub use day_spec::{InputPurpose, SubmitLabel};
220    // Canvas fonts and the platform font list (docs/fonts.md).
221    pub use day_spec::{CanvasFont, FontFace, FontFamilyInfo, TextMetrics};
222    pub use day_spec::{Font, FontSpec, FontWeight, Role};
223    // The styled-text document (docs/texteditor.md): what `.markdown()` parses into, what a
224    // label's runs are, and what `day-piece-text-editor` edits, plus the Markdown / HTML / RTF
225    // codecs over it.
226    pub use day_spec::{
227        Decoration, DecorationStyle, ListStyle, ParagraphRun, ParagraphStyle, RunStyle, StyledText,
228        TextRun,
229    };
230    pub use day_spec::{
231        LabelStyle, Symbol, ToolbarItem, ToolbarItemKind, ToolbarPlacement, ToolbarValue,
232    };
233    pub use day_spec::{MenuBarRole, MenuItem, MenuRole, Shortcut};
234    pub use std::time::Duration;
235}