Skip to main content

TabSpec

Struct TabSpec 

Source
pub struct TabSpec {
    pub name: String,
    pub label: String,
    pub icon: Option<String>,
    pub badge: Option<String>,
    pub body: TabBody,
}
Expand description

One handler-contributed tab appended to the page-editor’s built-in tab strip (Content / Promote / Theme / Revisions). See PageTypeHandler::extra_tabs.

The body is one of TabBody::Html (pre-rendered HTML — the escape hatch), TabBody::Template (Tera template path + extra context — render with the standard admin context vars in scope), or TabBody::Widgets (declarative widget list — rendered via _widget.html so the form fields look identical to the Content tab’s stack).

Inputs declared inside the rendered HTML land in PageTypeHandler::save_extension’s form HashMap automatically; every variant lives inside the page-edit <form>.

name must be unique within a page’s tab set. Mixing with the built-in names (content, promote, theme, revisions) is allowed and lets a handler override the BUILT-IN tab body without forking the template; the tab JS keys off data-tab-trigger="<name>" so identical names render the same panel.

Fields§

§name: String

Stable identifier — kebab-case is conventional. Used for aria-controls, URL hash links, and the per-page localStorage “remember last active tab” key.

§label: String

Visible label on the tab button.

§icon: Option<String>

Optional Material-symbols icon name (e.g. "workflow", "insights"). Rendered to the left of label.

§badge: Option<String>

Optional small chip rendered after label (e.g. an unread count, “new”, or a small status indicator).

§body: TabBody

What goes inside the tab panel — see TabBody.

Implementations§

Source§

impl TabSpec

Source

pub fn new( name: impl Into<String>, label: impl Into<String>, html: impl Into<String>, ) -> Self

Smallest possible spec — just (name, label, html). The html is treated as pre-rendered + emitted via Tera’s | safe. Backwards-compatible with the v0.2 surface.

Source

pub fn template( name: impl Into<String>, label: impl Into<String>, path: impl Into<String>, ) -> Self

Tera-template-backed tab. The renderer mounts path with the standard admin context plus the per-tab context map (empty until filled with Self::with_context_value). Example: TabSpec::template("seo", "SEO", "blog/seo_tab.html").

Source

pub fn widgets( name: impl Into<String>, label: impl Into<String>, widgets: Vec<Widget>, ) -> Self

Widget-group-backed tab. Same rendering pipeline the Content tab uses — each widget is emitted via _widget.html’s macro. Inputs submit alongside the page-edit form so the handler’s PageTypeHandler::save_extension picks them up by name.

Source

pub fn group( name: impl Into<String>, label: impl Into<String>, heading: impl Into<String>, widgets: Vec<Widget>, ) -> Self

Field-group tab — heading + (optional help) + widgets stacked under one section. Use Self::with_layout to switch to row layout.

Source

pub fn help( name: impl Into<String>, label: impl Into<String>, content: impl Into<String>, ) -> Self

Help tab — static HTML content, no form fields. The body is emitted via | safe, so authors control the markup.

Source

pub fn with_layout(self, layout: PanelLayout) -> Self

Switch a Group-body tab to a different layout. No-op on other body variants.

Source

pub fn with_help(self, help: impl Into<String>) -> Self

Attach help text to a Group-body tab. No-op on other body variants.

Source

pub fn with_icon(self, icon: impl Into<String>) -> Self

Source

pub fn with_badge(self, badge: impl Into<String>) -> Self

Source

pub fn with_context_value(self, key: impl Into<String>, value: Value) -> Self

Insert a context entry — only meaningful for the TabBody::Template variant; a no-op on Html / Widgets. Chain multiple times for multiple values.

Trait Implementations§

Source§

impl Clone for TabSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TabSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TabSpec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TabSpec

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more