diff options
| author |  Héctor Ramón <hector0193@gmail.com> | 2019-11-24 11:34:30 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2019-11-24 11:34:30 +0100 |
| commit | 149fd2aa1fa86858c7c1dcec8fd844caa78cec94 (patch) | |
| tree | a199cf8d2caaf6aa60e48e93d6dd0688969d43b0 /web/src/widget.rs | |
| parent | 9712b319bb7a32848001b96bd84977430f14b623 (diff) | |
| parent | 47196c9007d12d3b3e0036ffabe3bf6d14ff4523 (diff) | |
| download | iced-149fd2aa1fa86858c7c1dcec8fd844caa78cec94.tar.gz iced-149fd2aa1fa86858c7c1dcec8fd844caa78cec94.tar.bz2 iced-149fd2aa1fa86858c7c1dcec8fd844caa78cec94.zip | |
Merge pull request #65 from hecrj/improvement/docs
Documentation
Diffstat (limited to 'web/src/widget.rs')
| -rw-r--r-- | web/src/widget.rs | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/web/src/widget.rs b/web/src/widget.rs index 88b2efc9..30ac8eeb 100644 --- a/web/src/widget.rs +++ b/web/src/widget.rs @@ -1,15 +1,31 @@ +//! Use the built-in widgets or create your own. +//! +//! # Custom widgets +//! If you want to implement a custom widget, you simply need to implement the +//! [`Widget`] trait. You can use the API of the built-in widgets as a guide or +//! source of inspiration. +//! +//! # Re-exports +//! For convenience, the contents of this module are available at the root +//! module. Therefore, you can directly type: +//! +//! ``` +//! use iced_web::{button, Button, Widget}; +//! ``` +//! +//! [`Widget`]: trait.Widget.html use crate::Bus; use dodrio::bumpalo; pub mod button; pub mod slider; -pub mod text; mod checkbox; mod column; mod image; mod radio; mod row; +mod text; #[doc(no_inline)] pub use button::Button; @@ -26,7 +42,16 @@ pub use image::Image; pub use radio::Radio; pub use row::Row; +/// A component that displays information and allows interaction. +/// +/// If you want to build your own widgets, you will need to implement this +/// trait. +/// +/// [`Widget`]: trait.Widget.html pub trait Widget<Message> { + /// Produces a VDOM node for the [`Widget`]. + /// + /// [`Widget`]: trait.Widget.html fn node<'b>( &self, bump: &'b bumpalo::Bump, |