PaginationPagesProps

leptos_pagination

Struct PaginationPagesProps 

Source 
pub struct PaginationPagesProps {
    pub state: Store<PaginationState>,
    pub display_page_count: usize,
    pub margin_page_count: usize,
    pub separator: Signal<String>,
    pub anchor_class: Signal<String>,
    pub li_class: Signal<String>,
    pub active_class: Signal<String>,
    pub ul_class: Signal<String>,
    pub separator_class: Signal<String>,
}
Expand description

Props for the PaginationPages component.

A component that renders pagination page controls.

§Example

§Required Props

  • state: [Store<PaginationState>]
    • The current state of the pagination. This is used to communicate with the PaginatedFor component.

§Optional Props

  • display_page_count: usize

    • How many pages to show around the current page. This number includes the current page.

      A value of 3 will display one page before and one page after the current page. It’s recommended to use odd numbers to ensure symmetry.

      Default is 5.

  • margin_page_count: usize

    • How many pages to show at the beginning and end of the pagination.

      Default is 1.

  • separator: impl Into<Signal<String>>

    • The separator to use between page ranges.

      Default is “…”

  • anchor_class: impl Into<Signal<String>>
    • The class of the <a> element that represents a page.
  • li_class: impl Into<Signal<String>>
    • The class of the <li> element that wraps the <a> element that represents a page.
  • active_class: impl Into<Signal<String>>
    • The class of the <li> element that represents an active page. This will be used instead of the li_class when the page is active.
  • ul_class: impl Into<Signal<String>>
    • Every range is put inside an <ul> element. The class of this <ul> element can be customized using this prop.
  • separator_class: impl Into<Signal<String>>
    • The class of the <div> element that contains the separator.

Fields§

§state: Store<PaginationState>

The current state of the pagination. This is used to communicate with the PaginatedFor component.

§display_page_count: usize

How many pages to show around the current page. This number includes the current page.

A value of 3 will display one page before and one page after the current page. It’s recommended to use odd numbers to ensure symmetry.

Default is 5.

§margin_page_count: usize

How many pages to show at the beginning and end of the pagination.

Default is 1.

§separator: Signal<String>

The separator to use between page ranges.

Default is “…”

§anchor_class: Signal<String>

The class of the <a> element that represents a page.

§li_class: Signal<String>

The class of the <li> element that wraps the <a> element that represents a page.

§active_class: Signal<String>

The class of the <li> element that represents an active page. This will be used instead of the li_class when the page is active.

§ul_class: Signal<String>

Every range is put inside an <ul> element. The class of this <ul> element can be customized using this prop.

§separator_class: Signal<String>

The class of the <div> element that contains the separator.

Implementations§

Source§

impl PaginationPagesProps

Source

pub fn builder() -> PaginationPagesPropsBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building PaginationPagesProps. On the builder, call .state(...), .display_page_count(...)(optional), .margin_page_count(...)(optional), .separator(...)(optional), .anchor_class(...)(optional), .li_class(...)(optional), .active_class(...)(optional), .ul_class(...)(optional), .separator_class(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of PaginationPagesProps.

Trait Implementations§

Source§

impl Props for PaginationPagesProps

Source§

type Builder = PaginationPagesPropsBuilder

Source§

fn builder() -> Self::Builder

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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<El, T, Marker> IntoElementMaybeSignal<T, Marker> for El
where El: IntoElementMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_element_maybe_signal(self) -> ElementMaybeSignal<T>

Source§

impl<T, Js> IntoElementMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_element_maybe_signal_type(self) -> ElementMaybeSignalType<T>

Source§

impl<El, T, Marker> IntoElementsMaybeSignal<T, Marker> for El
where El: IntoElementsMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_elements_maybe_signal(self) -> ElementsMaybeSignal<T>

Source§

impl<T, Js> IntoElementsMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_elements_maybe_signal_type(self) -> ElementsMaybeSignalType<T>

Source§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<T> ErasedDestructor for T
where T: 'static,