Restore docs CI checks and fix all doc lints (#4204)
This commit is contained in:
1 parent
9027ffc278
commit
ee3b45af49
57 files changed
+120
-130
No files matched your search
@@ -36,7 +36,7 @@ impl<R> Clone for ChildRouteMapping<R> {
|
||||
}
|
||||
}
|
||||
|
||||
/// Props for the [`ChildHistoryProvider`] component.
|
||||
/// Props for the [`ChildRouter`] component.
|
||||
#[derive(Props, Clone)]
|
||||
pub struct ChildRouterProps<R: Routable> {
|
||||
/// The child route to render
|
||||
|
||||
@@ -13,12 +13,12 @@ pub struct HistoryButtonProps {
|
||||
|
||||
/// A button to go back through the navigation history. Similar to a browsers back button.
|
||||
///
|
||||
/// Only works as descendant of a [`Link`] component, otherwise it will be inactive.
|
||||
/// Only works as descendant of a [`super::Link`] component, otherwise it will be inactive.
|
||||
///
|
||||
/// The button will disable itself if it is known that no prior history is available.
|
||||
///
|
||||
/// # Panic
|
||||
/// - When the [`GoBackButton`] is not nested within a [`Link`] component
|
||||
/// - When the [`GoBackButton`] is not nested within a [`super::Link`] component
|
||||
/// hook, but only in debug builds.
|
||||
///
|
||||
/// # Example
|
||||
@@ -86,12 +86,12 @@ pub fn GoBackButton(props: HistoryButtonProps) -> Element {
|
||||
|
||||
/// A button to go forward through the navigation history. Similar to a browsers forward button.
|
||||
///
|
||||
/// Only works as descendant of a [`Link`] component, otherwise it will be inactive.
|
||||
/// Only works as descendant of a [`super::Link`] component, otherwise it will be inactive.
|
||||
///
|
||||
/// The button will disable itself if it is known that no later history is available.
|
||||
///
|
||||
/// # Panic
|
||||
/// - When the [`GoForwardButton`] is not nested within a [`Link`] component
|
||||
/// - When the [`GoForwardButton`] is not nested within a [`super::Link`] component
|
||||
/// hook, but only in debug builds.
|
||||
///
|
||||
/// # Example
|
||||
|
||||
@@ -31,7 +31,7 @@ pub struct LinkProps {
|
||||
pub onclick: Option<EventHandler<MouseEvent>>,
|
||||
|
||||
/// The onmounted event handler.
|
||||
/// Fired when the <a> element is mounted.
|
||||
/// Fired when the `<a>` element is mounted.
|
||||
pub onmounted: Option<EventHandler<MountedEvent>>,
|
||||
|
||||
#[props(default)]
|
||||
@@ -72,7 +72,7 @@ impl Debug for LinkProps {
|
||||
|
||||
/// A link to navigate to another route.
|
||||
///
|
||||
/// Only works as descendant of a [`Router`] component, otherwise it will be inactive.
|
||||
/// Only works as descendant of a [`super::Router`] component, otherwise it will be inactive.
|
||||
///
|
||||
/// Unlike a regular HTML anchor, a [`Link`] allows the router to handle the navigation and doesn't
|
||||
/// cause the browser to load a new page.
|
||||
@@ -82,10 +82,10 @@ impl Debug for LinkProps {
|
||||
///
|
||||
/// # External targets
|
||||
/// When the [`Link`]s target is an [`NavigationTarget::External`] target, that is used as the `href` directly. This
|
||||
/// means that a [`Link`] can always navigate to an [`NavigationTarget::External`] target, even if the [`HistoryProvider`] does not support it.
|
||||
/// means that a [`Link`] can always navigate to an [`NavigationTarget::External`] target, even if the [`dioxus_history::History`] does not support it.
|
||||
///
|
||||
/// # Panic
|
||||
/// - When the [`Link`] is not nested within a [`Router`], but
|
||||
/// - When the [`Link`] is not nested within a [`super::Router`], but
|
||||
/// only in debug builds.
|
||||
///
|
||||
/// # Example
|
||||
|
||||
Reference in new issue
Block a user