Skip to main content

OrbitalComponentViewProps

orbital_motion::preview::preview_shell

Struct OrbitalComponentViewProps 

Source 
pub struct OrbitalComponentViewProps<IV>
where
    IV: IntoView + 'static,
{
Show 13 fields
    pub component_name: &'static str,
    pub component_description: Option<&'static str>,
    pub component_description_md: Option<&'static str>,
    pub component_props: Option<&'static [ComponentPropDoc]>,
    pub component_best_practices: Option<&'static str>,
    pub component_best_practices_md: Option<&'static str>,
    pub default: IV,
    pub default_code: MaybeProp<&'static str>,
    pub default_example_title: MaybeProp<&'static str>,
    pub default_description: MaybeProp<&'static str>,
    pub default_example_id: MaybeProp<&'static str>,
    pub example_anchors: Option<&'static [(&'static str, &'static str)]>,
    pub children: Option<Children>,

}
Expand description

Props for the OrbitalComponentView component.

§Required Props

  • component_name: [&'static str]
  • default: [IV]

§Optional Props

  • component_description: [&'static str]
  • component_description_md: [&'static str]
  • component_props: [&'static [ComponentPropDoc]]
  • component_best_practices: [&'static str]
  • component_best_practices_md: [&'static str]
  • default_code: [impl Into<MaybeProp<&'static str>>](MaybeProp<&’static str>)
  • default_example_title: [impl Into<MaybeProp<&'static str>>](MaybeProp<&’static str>)
  • default_description: [impl Into<MaybeProp<&'static str>>](MaybeProp<&’static str>)
  • default_example_id: [impl Into<MaybeProp<&'static str>>](MaybeProp<&’static str>)
  • example_anchors: [&'static [(&'static str, &'static str)]]
  • children: Children

Fields§

§component_name: &'static str§component_description: Option<&'static str>§component_description_md: Option<&'static str>§component_props: Option<&'static [ComponentPropDoc]>§component_best_practices: Option<&'static str>§component_best_practices_md: Option<&'static str>§default: IV§default_code: MaybeProp<&'static str>§default_example_title: MaybeProp<&'static str>§default_description: MaybeProp<&'static str>§default_example_id: MaybeProp<&'static str>§example_anchors: Option<&'static [(&'static str, &'static str)]>§children: Option<Children>

Implementations§

Source§

impl<IV> OrbitalComponentViewProps<IV>
where IV: IntoView + 'static,

Source

pub fn builder() -> OrbitalComponentViewPropsBuilder<IV, ((), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building OrbitalComponentViewProps. On the builder, call .component_name(...), .component_description(...)(optional), .component_description_md(...)(optional), .component_props(...)(optional), .component_best_practices(...)(optional), .component_best_practices_md(...)(optional), .default(...), .default_code(...)(optional), .default_example_title(...)(optional), .default_description(...)(optional), .default_example_id(...)(optional), .example_anchors(...)(optional), .children(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of OrbitalComponentViewProps.

Trait Implementations§

Source§

impl<IV> Props for OrbitalComponentViewProps<IV>
where IV: IntoView + 'static,

Source§

type Builder = OrbitalComponentViewPropsBuilder<IV>

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<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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more