Show toggler doc example in multiple places
This commit is contained in:
parent
e0c55cbb19
commit
22fbb9c221
2 changed files with 86 additions and 9 deletions
|
|
@ -947,7 +947,38 @@ where
|
||||||
|
|
||||||
/// Creates a new [`Toggler`].
|
/// Creates a new [`Toggler`].
|
||||||
///
|
///
|
||||||
/// [`Toggler`]: crate::Toggler
|
/// Togglers let users make binary choices by toggling a switch.
|
||||||
|
///
|
||||||
|
/// # Example
|
||||||
|
/// ```no_run
|
||||||
|
/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
||||||
|
/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>;
|
||||||
|
/// #
|
||||||
|
/// use iced::widget::toggler;
|
||||||
|
///
|
||||||
|
/// struct State {
|
||||||
|
/// is_checked: bool,
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// TogglerToggled(bool),
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// toggler(state.is_checked)
|
||||||
|
/// .label("Toggle me!")
|
||||||
|
/// .on_toggle(Message::TogglerToggled)
|
||||||
|
/// .into()
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn update(state: &mut State, message: Message) {
|
||||||
|
/// match message {
|
||||||
|
/// Message::TogglerToggled(is_checked) => {
|
||||||
|
/// state.is_checked = is_checked;
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
pub fn toggler<'a, Message, Theme, Renderer>(
|
pub fn toggler<'a, Message, Theme, Renderer>(
|
||||||
is_checked: bool,
|
is_checked: bool,
|
||||||
) -> Toggler<'a, Message, Theme, Renderer>
|
) -> Toggler<'a, Message, Theme, Renderer>
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,35 @@
|
||||||
//! Show toggle controls using togglers.
|
//! Togglers let users make binary choices by toggling a switch.
|
||||||
|
//!
|
||||||
|
//! # Example
|
||||||
|
//! ```no_run
|
||||||
|
//! # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
||||||
|
//! # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>;
|
||||||
|
//! #
|
||||||
|
//! use iced::widget::toggler;
|
||||||
|
//!
|
||||||
|
//! struct State {
|
||||||
|
//! is_checked: bool,
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! enum Message {
|
||||||
|
//! TogglerToggled(bool),
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
//! toggler(state.is_checked)
|
||||||
|
//! .label("Toggle me!")
|
||||||
|
//! .on_toggle(Message::TogglerToggled)
|
||||||
|
//! .into()
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! fn update(state: &mut State, message: Message) {
|
||||||
|
//! match message {
|
||||||
|
//! Message::TogglerToggled(is_checked) => {
|
||||||
|
//! state.is_checked = is_checked;
|
||||||
|
//! }
|
||||||
|
//! }
|
||||||
|
//! }
|
||||||
|
//! ```
|
||||||
use crate::core::alignment;
|
use crate::core::alignment;
|
||||||
use crate::core::event;
|
use crate::core::event;
|
||||||
use crate::core::layout;
|
use crate::core::layout;
|
||||||
|
|
@ -16,19 +47,34 @@ use crate::core::{
|
||||||
/// A toggler widget.
|
/// A toggler widget.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # type Toggler<'a, Message> = iced_widget::Toggler<'a, Message>;
|
/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
||||||
|
/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>;
|
||||||
/// #
|
/// #
|
||||||
/// pub enum Message {
|
/// use iced::widget::toggler;
|
||||||
|
///
|
||||||
|
/// struct State {
|
||||||
|
/// is_checked: bool,
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
/// TogglerToggled(bool),
|
/// TogglerToggled(bool),
|
||||||
/// }
|
/// }
|
||||||
///
|
///
|
||||||
/// let is_toggled = true;
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// toggler(state.is_checked)
|
||||||
|
/// .label("Toggle me!")
|
||||||
|
/// .on_toggle(Message::TogglerToggled)
|
||||||
|
/// .into()
|
||||||
|
/// }
|
||||||
///
|
///
|
||||||
/// Toggler::new(is_toggled)
|
/// fn update(state: &mut State, message: Message) {
|
||||||
/// .label("Toggle me!")
|
/// match message {
|
||||||
/// .on_toggle(Message::TogglerToggled);
|
/// Message::TogglerToggled(is_checked) => {
|
||||||
|
/// state.is_checked = is_checked;
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
#[allow(missing_debug_implementations)]
|
#[allow(missing_debug_implementations)]
|
||||||
pub struct Toggler<
|
pub struct Toggler<
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue