Struct Props

pub struct Props {

    pub type: &'static str,
    pub label: &'static str,
    pub name: &'static str,
    pub required: bool,
    pub ref: NodeRef,
    pub error_message: &'static str,
    pub input_class: &'static str,
    pub field_class: &'static str,
    pub label_class: &'static str,
    pub class: &'static str,
    pub error_class: &'static str,
    pub icon_class: &'static str,
    pub handle: UseStateHandle<String>,
    pub valid_handle: UseStateHandle<bool>,
    pub validate_function: Callback<String, bool>,
    pub eye_active: &'static str,
    pub eye_disabled: &'static str,
    pub id: &'static str,
    pub placeholder: &'static str,
    pub aria_label: &'static str,
    pub aria_required: &'static str,
    pub aria_invalid: &'static str,
    pub aria_describedby: &'static str,
    pub accept: &'static str,
    pub alt: &'static str,
    pub autocapitalize: &'static str,
    pub autocomplete: &'static str,
    pub capture: &'static str,
    pub checked: bool,
    pub dirname: &'static str,
    pub disabled: bool,
    pub form: &'static str,
    pub formaction: &'static str,
    pub formenctype: &'static str,
    pub formmethod: &'static str,
    pub formnovalidate: bool,
    pub formtarget: &'static str,
    pub height: Option<u32>,
    pub list: &'static str,
    pub max: &'static str,
    pub maxlength: Option<usize>,
    pub min: &'static str,
    pub minlength: Option<usize>,
    pub multiple: bool,
    pub pattern: &'static str,
    pub readonly: bool,
    pub size: Option<u32>,
    pub src: &'static str,
    pub step: &'static str,
    pub value: &'static str,
    pub width: Option<u32>,
}

Available on crate feature yew only.

Props for a custom input component. This struct includes all possible attributes for an HTML <input> element. See MDN docs for more details.

Fields

type: &'static str

The type of the input, e.g., “text”, “password”, etc.

label: &'static str

The label to be displayed for the input field.

name: &'static str

The name of the input field, used for form submission and accessibility.

required: bool

Indicates whether the input is required or not.

ref: NodeRef

A reference to the DOM node of the input element.

error_message: &'static str

The error message to display when there is a validation error.

input_class: &'static str

The CSS class to be applied to all inner elements.

field_class: &'static str

The CSS class to be applied to the inner input element and icon.

label_class: &'static str

The CSS class to be applied to the label for the input element.

class: &'static str

The CSS class to be applied to the input element.

error_class: &'static str

The CSS class to be applied to the error div element.

icon_class: &'static str

The CSS class to be applied to the icon element.

handle: UseStateHandle<String>

The state handle for managing the value of the input.

valid_handle: UseStateHandle<bool>

The state handle for managing the validity state of the input.

validate_function: Callback<String, bool>

A callback function to validate the input value. It takes a String as input and returns a bool.

eye_active: &'static str

The icon when the password is visible. Assuming fontawesome icons are used by default.

eye_disabled: &'static str

The icon when the password is not visible. Assuming fontawesome icons are used by default.

id: &'static str

The ID attribute of the input element.

placeholder: &'static str

The placeholder text to be displayed in the input element.

aria_label: &'static str

The aria-label attribute for screen readers, providing a label for accessibility.

aria_required: &'static str

The aria-required attribute for screen readers, indicating whether the input is required.

aria_invalid: &'static str

The aria-invalid attribute for screen readers, indicating whether the input value is invalid.

aria_describedby: &'static str

The aria-describedby attribute for screen readers, describing the input element’s error message.

accept: &'static str

Hint for expected file type in file upload controls.

alt: &'static str

The alternative text for <input type="image">. Required for accessibility.

autocapitalize: &'static str

Controls automatic capitalization in inputted text.

autocomplete: &'static str

Hint for the browser’s autofill feature.

capture: &'static str

Media capture input method in file upload controls.

checked: bool

Whether the control is checked (for checkboxes or radio buttons).

dirname: &'static str

Name of the form field to use for sending the element’s directionality in form submission.

disabled: bool

Whether the form control is disabled.

form: &'static str

Associates the input with a specific form element.

formaction: &'static str

URL to use for form submission (for <input type="image" | "submit">).

formenctype: &'static str

Form data set encoding type for submission (for <input type="image" | "submit">).

formmethod: &'static str

HTTP method to use for form submission (for <input type="image" | "submit">).

formnovalidate: bool

Bypass form validation for submission (for <input type="image" | "submit">).

formtarget: &'static str

Browsing context for form submission (for <input type="image" | "submit">).

height: Option<u32>

Same as the height attribute for <img> elements.

list: &'static str

ID of the <datalist> element to use for autocomplete suggestions.

max: &'static str

The maximum value for date, number, range, etc.

maxlength: Option<usize>

Maximum length of the input value (in characters).

min: &'static str

The minimum value for date, number, range, etc.

minlength: Option<usize>

Minimum length of the input value (in characters).

multiple: bool

Boolean indicating whether multiple values are allowed (for file inputs, emails, etc.).

pattern: &'static str

Regex pattern the value must match to be valid.

readonly: bool

Boolean indicating whether the input is read-only.

size: Option<u32>

Size of the input field (e.g., character width).

src: &'static str

Address of the image resource for <input type="image">.

step: &'static str

Incremental values that are valid for the input.

value: &'static str

The value of the control (used for two-way data binding).

width: Option<u32>

Same as the width attribute for <img> elements.

Trait Implementations

impl Clone for Props

fn clone(&self) -> Props

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for Props

fn eq(&self, other: &Props) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for Props

type Builder = PropsBuilder

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl StructuralPartialEq for Props