Crate orbital_history 

Orbital History — composable audit timeline for Leptos.

Host applications own data fetch and domain models; Orbital owns presentation, formatting defaults, layout, slots, and render extensibility.

Modules

preview

Preview catalog registration for orbital-history.

Structs

HistoryAttachment

Attachment metadata for markdown image dedup in history change bodies.

HistoryChangeSlot

Props for the HistoryChangeSlot slot.

HistoryChangeSlotBuilder

Builder for HistoryChangeSlot instances.

HistoryCitation

Citation metadata for markdown [^id] refs in history change bodies.

HistoryContext

Shared timeline context for leaf components.

HistoryEmptyView

Props for the HistoryEmptyView slot.

HistoryEmptyViewBuilder

Builder for HistoryEmptyView instances.

HistoryEndView

Props for the HistoryEndView slot.

HistoryEndViewBuilder

Builder for HistoryEndView instances.

HistoryEntry

One audit-timeline row.

HistoryEntrySlot

Props for the HistoryEntrySlot slot.

HistoryEntrySlotBuilder

Builder for HistoryEntrySlot instances.

HistoryErrorView

Props for the HistoryErrorView slot.

HistoryErrorViewBuilder

Builder for HistoryErrorView instances.

HistoryEvents

Interaction-only callbacks (no network inside the crate).

HistoryFeatures

Opt-in / opt-out capabilities (runtime; not Cargo features).

HistoryFetchParams

Parameters passed to a server HistoryPageFetcher.

HistoryFieldDiff

One field change inside a multi-field card.

HistoryFilter

Client-side filter over currently loaded history entries.

HistoryFilterActorOption

One selectable actor for filter chrome (id + display label).

HistoryHandle

Imperative handle for programmatic HistoryTimeline actions.

HistoryHeader

Props for the HistoryHeader slot.

HistoryHeaderBuilder

Builder for HistoryHeader instances.

HistoryLoadingMoreView

Props for the HistoryLoadingMoreView slot.

HistoryLoadingMoreViewBuilder

Builder for HistoryLoadingMoreView instances.

HistoryLoadingView

Props for the HistoryLoadingView slot.

HistoryLoadingViewBuilder

Builder for HistoryLoadingView instances.

HistoryLocale

User-facing strings and format templates for the history timeline.

HistoryMarkdownRenderOptions

Feature toggles for history markdown rendering.

HistoryMention

Mention metadata for @[label](id) refs in markdown change bodies.

HistoryPaginationView

Props for the HistoryPaginationView slot.

HistoryPaginationViewBuilder

Builder for HistoryPaginationView instances.

HistoryRelativeTimeLocale

Relative time formatting strings.

HistoryRenderContext

Context passed to history render callbacks.

HistoryRenderers

Host render overrides. Slots win when both prop and slots are set.

HistoryRowViewport

Visible index window with spacer padding heights.

HistorySerializedState

Serializable snapshot of timeline UI state for deep-linking and host persistence.

HistorySlots

Internal slot content consumed by the timeline.

Enums

HistoryActor

Who performed the change.

HistoryChange

Structured change payload for default formatting.

HistoryDateBucket

Relative date section for dividers (UTC calendar days).

HistoryGroupBy

Group consecutive timeline entries for collapse UI.

HistoryLayout

Timeline entry layout.

HistoryListItem

Projected list item: section divider, unread divider, group header, or entry.

HistoryLiveScrollPolicy

Scroll behavior when live entries merge above server pages.

HistoryPagingMode

How Server sources load pages. Client always renders the full signal list.

HistorySort

Client-side sort order (only when HistoryFeatures::CLIENT_SORT is enabled).

HistorySource

Data source: in-memory list or server page fetcher.

Constants

DEFAULT_HISTORY_ROW_HEIGHT_PX

Default row height estimate for history entry rows (px).

DEFAULT_HISTORY_ROW_OVERSCAN

Default overscan rows above/below the visible window.

DEFAULT_TRUNCATE_LEN

Default max display length for substituted values.

HISTORY_VIRTUALIZE_THRESHOLD

Minimum item count before virtualization activates.

Statics

HISTORYDATASOURCEDOC_PREVIEW_REGISTRATION

HISTORYDATEDIVIDERSDOC_PREVIEW_REGISTRATION

HISTORYEMBEDDOC_PREVIEW_REGISTRATION

HISTORYFILTERDOC_PREVIEW_REGISTRATION

HISTORYGROUPINGDOC_PREVIEW_REGISTRATION

HISTORYHANDLEDOC_PREVIEW_REGISTRATION

HISTORYLAYOUTDOC_PREVIEW_REGISTRATION

HISTORYLIVETRANSPORTDOC_PREVIEW_REGISTRATION

HISTORYLIVEUPDATEDOC_PREVIEW_REGISTRATION

HISTORYLOADINGDOC_PREVIEW_REGISTRATION

HISTORYLOCALIZATIONDOC_PREVIEW_REGISTRATION

HISTORYMARKDOWNDOC_PREVIEW_REGISTRATION

HISTORYMULTIDIFFDOC_PREVIEW_REGISTRATION

HISTORYPAGEDDOC_PREVIEW_REGISTRATION

HISTORYREFRESHDOC_PREVIEW_REGISTRATION

HISTORYRENDERERSDOC_PREVIEW_REGISTRATION

HISTORYSCROLLLOADDOC_PREVIEW_REGISTRATION

HISTORYSERVERFILTERDOC_PREVIEW_REGISTRATION

HISTORYSLOTSDOC_PREVIEW_REGISTRATION

HISTORYSORTDOC_PREVIEW_REGISTRATION

HISTORYTIMELINE_PREVIEW_REGISTRATION

HISTORYTIMEZONEBUCKETSDOC_PREVIEW_REGISTRATION

HISTORYTIMEZONEDISPLAYDOC_PREVIEW_REGISTRATION

HISTORYVIRTUALIZEDDOC_PREVIEW_REGISTRATION

Functions

HistoryActorLabel

Actor label: system text or user name / link.

HistoryChangeCard

Multi-field change card for HistoryChange::FieldDiffs.

HistoryChangeLine

Single-line formatted change summary (or markdown body when enabled).

HistoryDataSourceDoc

Client signal vs server page fetcher data sources.

HistoryDateDivider

Relative date-bucket section header.

HistoryDateDividersDoc

Relative date-bucket dividers (Today / Yesterday / …).

HistoryDefaultEmptyView

Default empty-state message.

HistoryDefaultEndView

Default end-of-list caption.

HistoryDefaultErrorView

Default error-state message.

HistoryDefaultFilterChrome

Default search input bound to the active filter (requires HistoryFeatures::FILTER_CHROME).

HistoryDefaultHeader

Default title header for the timeline.

HistoryDefaultLoadingMoreView

Default incremental loading footer.

HistoryDefaultNoMatchesView

Empty state when a filter is active but nothing matches.

HistoryDefaultPagination

Default page-number footer for Server + HistoryPagingMode::Paged.

HistoryDefaultSortChrome

Default newest/oldest toggle (requires HistoryFeatures::CLIENT_SORT + HistoryFeatures::SORT_CHROME).

HistoryDefaultToolbar

Toolbar region with optional filter and sort chrome.

HistoryDialog

Generic dialog shell around HistoryTimeline.

HistoryEmbedDoc

Dialog embed via [HistoryDialog] or max_height on the timeline.

HistoryEntryList

Render a list of history entries with optional sort, filter, date dividers, and virtualization.

HistoryEntryRow

One history entry row (natural timeline or compact sentence layout).

HistoryEntryRowSkeleton

One placeholder entry row for initial load.

HistoryFilterDoc

Filter loaded entries via a controlled filter signal or built-in chrome.

HistoryGroupHeader

Collapsible group header for consecutive actor/kind runs.

HistoryGroupingDoc

Collapse consecutive entries by actor or kind when GROUP_COLLAPSE is enabled.

HistoryHandleDoc

Imperative handle for scroll-to-entry and scroll-to-top.

HistoryKindEntryRow

Standard entry chrome (timestamp, actor, spine) for custom kind_views renderers.

HistoryLayoutDoc

Natural timeline (default) and compact inline sentence layout.

HistoryLiveTransportDoc

Host-owned live updates: no WS/SSE inside Orbital — wire your transport, push entries via hooks.

HistoryLiveUpdateDoc

Live updates without a transport protocol: Client prepend, Server live_head, and prepend_live.

HistoryLoadingDoc

Initial skeleton vs incremental footer loading.

HistoryLocalizationDoc

English and French locale presets.

HistoryMarkdownBody

Read-only markdown body with citation click and mention hover card.

HistoryMarkdownDoc

Read-only markdown rendering for change bodies when MARKDOWN_BODIES is enabled.

HistoryMultiDiffDoc

Multi-field change card for HistoryChange::FieldDiffs.

HistoryPagedDoc

Server paged mode with footer page controls and optional pagination slot.

HistoryRefreshDoc

Server refresh via [HistoryHandle::refresh].

HistoryRenderersDoc

Custom kind renderers with fallthrough to defaults.

HistoryScrollLoadDoc

Load pages until an entry id is found (scroll_to_entry_or_load).

HistoryServerFilterDoc

Server fetcher receives filter criteria when SERVER_FILTER is enabled.

HistorySlotsDoc

Structural chrome slots for header, empty, and end states.

HistorySortDoc

Client-side newest/oldest sort behind CLIENT_SORT.

HistoryTimeline

Scrollable audit timeline from a client signal or server page fetcher.

HistoryTimelineSkeleton

Full timeline skeleton for initial load.

HistoryTimestamp

Compact timestamp for a history entry.

HistoryTimezoneBucketsDoc

Date-bucket dividers using a display timezone.

HistoryTimezoneDisplayDoc

Compact timestamps follow display_timezone.

HistoryUnreadDivider

Divider marking the boundary between read and unread entries.

HistoryVirtualizedDoc

Windowed rendering for long client lists when VIRTUALIZE is enabled.

apply_filter

Filter loaded entries by query / kind / actor id.

apply_sort

Sort entries by changed_at (stable by id on ties).

attach_row_height_observer

change_view_fn

Helper to build a change-view arc from a closure.

compute_history_viewport

Compute which list item indices to render for a scroll position.

compute_variable_viewport

Compute a visible window for variable-height list items.

entry_view_fn

Helper to build an entry-view arc from a closure.

format_change

Format a change payload using locale templates.

history_date_bucket

Assign a relative date bucket for changed_at relative to now (UTC calendar days).

history_date_bucket_in_tz

Assign a relative date bucket using wall-clock calendar days in tz.

history_locale_signal

Signal-backed locale for reactive language toggles.

history_styles

CSS for the history timeline shell and entry rows.

insert_unread_divider

Insert an unread divider before the first unread entry in a projected list.

is_entry_unread

Returns true when the entry is unread relative to watermark.

list_item_cache_key

Stable cache key for a list item.

list_item_heights

Resolve heights for each list item, using cache or fallback estimate.

merge_live_head

Prepend live entries above fetched, dropping duplicates by id.

page_fetcher

Wrap a legacy PageRequest-only fetcher (ignores filter / sort).

project_entry_groups

Collapse consecutive entries sharing the same actor or kind.

provide_history_context

render_history_markdown

Render a history change body as sanitized HTML (read-only).

resolve_history_locale

Resolve locale from an optional override, falling back to English defaults.

scroll_offset_for_index

Cumulative offset to the top of index (sum of prior item heights).

truncate_display_value

Truncate a display string with a Unicode ellipsis when over max_len.

use_history_context

with_date_dividers

Project entries into a list with date-bucket dividers (newest-first input, UTC days).

with_date_dividers_in_tz

Project entries into a list with date-bucket dividers in tz.

with_date_dividers_on_list_items

Insert date-bucket dividers into a projected list (entries and group headers).

with_unread_divider

Insert an unread divider before the first unread entry when enabled.

Type Aliases

HistoryChangeView

Change-region override inside default chrome. Return None to fall through.

HistoryEntryView

Full-row override. Return None to fall through.

HistoryPageFetcher

Async fetcher for server-driven history pages.

HistoryRowHeightCache

Measured row heights keyed by entry id or divider sentinel.