Struct TableHeader

pub struct TableHeader { /* private fields */ }

Available on crate feature yew only.

A table header component that renders column headers with optional sorting functionality.

This component is part of the table_rs Yew integration and is responsible for rendering the <thead> section of a table. It supports sortable columns and emits sort events when a sortable header is clicked.

Arguments

• props - The properties passed to the component.
  • columns - A list of column definitions (Vec<Column>) specifying the headers to render.
  • sort_column - An Option<&'static str> indicating the currently sorted column, if any.
  • sort_order - A SortOrder indicating whether the sort is ascending or descending.
  • on_sort_column - A Callback<&'static str> triggered when a sortable column is clicked.
  • classes - A TableClasses object defining CSS class names for customization.

Returns

(Html): A rendered <thead> element containing the table header row and interactive sorting logic.

Examples

use table_rs::yew::header::TableHeader;
use table_rs::yew::types::{TableHeaderProps, Column, SortOrder, TableClasses};
use yew::prelude::*;

#[function_component(App)]
pub fn app() -> Html {
    let columns = vec![
        Column { id: "name", header: "Name", sortable: true, ..Default::default() },
        Column { id: "email", header: "Email", sortable: false, ..Default::default() },
    ];

    let sort_order = use_state(|| SortOrder::Asc);
    let sort_column = use_state(|| Some("name"));

    let props = TableHeaderProps {
        columns,
        sort_column: sort_column,
        sort_order: sort_order,
        on_sort_column: Callback::from(|col_id| web_sys::console::log_1(&format!("Sort: {}", col_id).into())),
        classes: Default::default(),
    };
    
    html! {
        <TableHeader ..props />
    }
};

See Also

• MDN thead Element

Trait Implementations

impl BaseComponent for TableHeader

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = TableHeaderProps

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl Debug for TableHeader

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

Formats the value using the given formatter.

impl FunctionProvider for TableHeader

type Properties = TableHeaderProps

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.