yew-oauth2 0.14.0

OAuth2 components for Yew
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

#![cfg_attr(docsrs, feature(doc_cfg))]
//! Yew components to implement OAuth2 and OpenID Connect logins.
//!
//! ## OAuth2 or Open ID Connect
//!
//! This crate supports both plain OAuth2 and Open ID Connect (OIDC). OIDC layers a few features
//! on top of OAuth2 (like logout URLs, discovery, …).
//!
//! In order to use OIDC, you will need to enable the feature `openid`.
//!
//! ## Example
//!
//! **NOTE:** Also see the [readme](https://github.com/ctron/yew-oauth2/blob/main/README.md#examples) for more examples.
//!
//! The following is a basic example:
//!
//! ```rust
//! use yew::prelude::*;
//! use yew_oauth2::prelude::*;
//! use yew_oauth2::oauth2::*; // use `openid::*` when using OpenID connect
//!
//! #[component(MyApplication)]
//! fn my_app() -> Html {
//!   let config = Config::new(
//!     "my-client",
//!     "https://my-sso/auth/realms/my-realm/protocol/openid-connect/auth",
//!     "https://my-sso/auth/realms/my-realm/protocol/openid-connect/token"
//!   );
//!
//!   html!(
//!     <OAuth2 {config}>
//!       <MyApplicationMain/>
//!     </OAuth2>
//!   )
//! }
//!
//! #[component(MyApplicationMain)]
//! fn my_app_main() -> Html {
//!   let agent = use_auth_agent().expect("Must be nested inside an OAuth2 component");
//!
//!   let login = use_callback(agent.clone(), |_, agent| {
//!     let _ = agent.start_login();
//!   });
//!   let logout = use_callback(agent, |_, agent| {
//!     let _ = agent.logout();
//!   });
//!
//!   html!(
//!     <>
//!       <Failure><FailureMessage/></Failure>
//!       <Authenticated>
//!         <button onclick={logout}>{ "Logout" }</button>
//!       </Authenticated>
//!       <NotAuthenticated>
//!         <button onclick={login}>{ "Login" }</button>
//!       </NotAuthenticated>
//!     </>
//!   )
//! }
//! ```

pub mod agent;
pub mod components;
pub mod config;
pub mod context;
pub mod hook;
pub mod prelude;

#[cfg(feature = "openid")]
pub mod openid {
    //! Common used Open ID Connect features
    pub use crate::agent::client::OpenIdClient as Client;
    pub use crate::components::context::openid::*;
    pub use crate::components::redirect::location::openid::*;
    #[cfg(feature = "yew-nested-router")]
    pub use crate::components::redirect::router::openid::*;
    pub use crate::config::openid::*;

    #[yew::hook]
    pub fn use_auth_agent() -> Option<crate::components::context::Agent<Client>> {
        crate::components::context::use_auth_agent::<Client>()
    }
}

pub mod oauth2 {
    //! Common used OAuth2 features
    pub use crate::agent::client::OAuth2Client as Client;
    pub use crate::components::context::oauth2::*;
    pub use crate::components::redirect::location::oauth2::*;
    #[cfg(feature = "yew-nested-router")]
    pub use crate::components::redirect::router::oauth2::*;
    pub use crate::config::oauth2::*;

    #[yew::hook]
    pub fn use_auth_agent() -> Option<crate::components::context::Agent<Client>> {
        crate::components::context::use_auth_agent::<Client>()
    }
}