Add prompt function to the dialogue service.
#1350
Conversation
* Improve the clarity of some doc comments * Fix a typo in a `map_err`
teymour-aldridge
force-pushed
the
refactorings
branch
from
e4baa2e to
52e1017
Compare
teymour-aldridge
force-pushed
the
refactorings
branch
from
52e1017 to
51ce041
Compare
yew/src/services/dialog.rs
Outdated
| pub fn prompt( | ||
| message: &str, | ||
| #[cfg(feature = "web_sys")] default: Option<&str>, | ||
| #[cfg(feature = "std_web")] _: Option<&str>, |
There was a problem hiding this comment.
Do we need this argument on std_web?
There was a problem hiding this comment.
We don't, but it gets messy if functions have different signatures IMO.
There was a problem hiding this comment.
We generate separate docs for stdweb so I think it should be ok, do you have other concerns?
There was a problem hiding this comment.
Nope. I'll remove the argument on stdweb (+ add a note in the docstring).
There was a problem hiding this comment.
Oh, I didn't think about the doc string! You can check out yew/src/lib.rs for example on how to render conditional docs
| @@ -41,4 +44,45 @@ impl DialogService { | |||
| feature = "web_sys" => utils::window().confirm_with_message(message).unwrap(), | |||
| } | |||
| } | |||
|
|
|||
| /// Prompts the user to input a message. In most browsers this will open an alert box with | |||
There was a problem hiding this comment.
Could you add a note about what this function returns. For example, when does it return None? I think we might be able to add a test for that case btw
There was a problem hiding this comment.
Ooh, that's a good idea. I want to look into developing a set of integration tests (ideally from the examples) as well so that we can test things which can only be tested in a browser.
* Add `prompt` function to the dialogue service. * Improve the clarity of some doc comments * Fix a typo in a `map_err` * Fix `cfg_match!` usage. * Add `stdweb` support. * Fix the `prompt` method. * Add different docs for `stdweb` and `web_sys`.
map_errDescription
Checklist:
./ci/run_stable_checks.sh[ ] I have added testsdoesn't apply