summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 06:14:56 +0200
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 06:14:56 +0200
commit184ebebfe12c9ea68b91a0a5db59f8b599b5bc5d (patch)
tree977aaa8f444faf7f91d7f7cc30874cfb76d1b5c0
parent6ad7c7d3080816d37b17f1f6f5af5d8761983fdc (diff)
downloadiced-184ebebfe12c9ea68b91a0a5db59f8b599b5bc5d.tar.gz
iced-184ebebfe12c9ea68b91a0a5db59f8b599b5bc5d.tar.bz2
iced-184ebebfe12c9ea68b91a0a5db59f8b599b5bc5d.zip
Show `text_editor` example in multiple places
-rw-r--r--widget/src/helpers.rs34
-rw-r--r--widget/src/text_editor.rs66
2 files changed, 98 insertions, 2 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 142d64d6..ca401a89 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -975,7 +975,39 @@ where
/// Creates a new [`TextEditor`].
///
-/// [`TextEditor`]: crate::TextEditor
+/// Text editors display a multi-line text input for text editing.
+///
+/// # 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::text_editor;
+///
+/// struct State {
+/// content: text_editor::Content,
+/// }
+///
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// Edit(text_editor::Action)
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// text_editor(&state.content)
+/// .placeholder("Type something here...")
+/// .on_action(Message::Edit)
+/// .into()
+/// }
+///
+/// fn update(state: &mut State, message: Message) {
+/// match message {
+/// Message::Edit(action) => {
+/// state.content.perform(action);
+/// }
+/// }
+/// }
+/// ```
pub fn text_editor<'a, Message, Theme, Renderer>(
content: &'a text_editor::Content<Renderer>,
) -> TextEditor<'a, core::text::highlighter::PlainText, Message, Theme, Renderer>
diff --git a/widget/src/text_editor.rs b/widget/src/text_editor.rs
index 1df97962..59795318 100644
--- a/widget/src/text_editor.rs
+++ b/widget/src/text_editor.rs
@@ -1,4 +1,36 @@
-//! Display a multi-line text input for text editing.
+//! Text editors display a multi-line text input for text editing.
+//!
+//! # 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::text_editor;
+//!
+//! struct State {
+//! content: text_editor::Content,
+//! }
+//!
+//! #[derive(Debug, Clone)]
+//! enum Message {
+//! Edit(text_editor::Action)
+//! }
+//!
+//! fn view(state: &State) -> Element<'_, Message> {
+//! text_editor(&state.content)
+//! .placeholder("Type something here...")
+//! .on_action(Message::Edit)
+//! .into()
+//! }
+//!
+//! fn update(state: &mut State, message: Message) {
+//! match message {
+//! Message::Edit(action) => {
+//! state.content.perform(action);
+//! }
+//! }
+//! }
+//! ```
use crate::core::alignment;
use crate::core::clipboard::{self, Clipboard};
use crate::core::event::{self, Event};
@@ -27,6 +59,38 @@ use std::sync::Arc;
pub use text::editor::{Action, Edit, Motion};
/// A multi-line text input.
+///
+/// # 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::text_editor;
+///
+/// struct State {
+/// content: text_editor::Content,
+/// }
+///
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// Edit(text_editor::Action)
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// text_editor(&state.content)
+/// .placeholder("Type something here...")
+/// .on_action(Message::Edit)
+/// .into()
+/// }
+///
+/// fn update(state: &mut State, message: Message) {
+/// match message {
+/// Message::Edit(action) => {
+/// state.content.perform(action);
+/// }
+/// }
+/// }
+/// ```
#[allow(missing_debug_implementations)]
pub struct TextEditor<
'a,