Skip to content

Commit

Permalink
add back "FooComponent properties" links
Browse files Browse the repository at this point in the history
  • Loading branch information
tigerros committed Apr 12, 2024
1 parent e380a74 commit 0487b42
Show file tree
Hide file tree
Showing 20 changed files with 27 additions and 0 deletions.
2 changes: 2 additions & 0 deletions crates/components/src/accordion.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ pub enum AccordionStatus {
Hovering,
}

/// [`Accordion`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct AccordionProps {
/// Theme override.
Expand Down Expand Up @@ -107,6 +108,7 @@ pub fn Accordion(props: AccordionProps) -> Element {
)
}

/// [`AccordionSummary`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct AccordionSummaryProps {
/// Inner children for the AccordionSummary.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/body.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use freya_elements::elements as dioxus_elements;

use freya_hooks::{use_applied_theme, BodyTheme, BodyThemeWith};

/// [`Body`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct BodyProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/button.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use freya_elements::events::{KeyboardEvent, MouseEvent};
use freya_hooks::{use_applied_theme, use_focus, use_platform, ButtonTheme, ButtonThemeWith};
use winit::window::CursorIcon;

/// [`Button`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct ButtonProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/canvas.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use freya_elements::elements as dioxus_elements;

use freya_hooks::{use_applied_theme, CanvasTheme, CanvasThemeWith, UseCanvas};

/// [`Canvas`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct CanvasProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/cursor_area.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use freya_elements::elements as dioxus_elements;
use freya_hooks::use_platform;
pub use winit::window::CursorIcon;

/// [`CursorArea`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct CursorAreaProps {
/// Cursor icon that will be used when hovering this area.
Expand Down
3 changes: 3 additions & 0 deletions crates/components/src/drag_drop.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use freya_elements::events::MouseEvent;
use freya_hooks::use_node_signal;
use torin::prelude::CursorPoint;

/// [`DragProvider`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct DragProviderProps {
/// Inner children of the DragProvider.
Expand All @@ -17,6 +18,7 @@ pub fn DragProvider<T: 'static>(DragProviderProps { children }: DragProviderProp
rsx!({ children })
}

/// [`DragZone`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct DragZoneProps<T: Clone + 'static + PartialEq> {
/// Element visible when dragging the element. This follows the cursor.
Expand Down Expand Up @@ -97,6 +99,7 @@ pub fn DragZone<T: 'static + Clone + PartialEq>(
)
}

/// [`DropZone`] component properties.
#[derive(Props, PartialEq, Clone)]
pub struct DropZoneProps<T: 'static + PartialEq + Clone> {
/// Inner children for the DropZone.
Expand Down
2 changes: 2 additions & 0 deletions crates/components/src/dropdown.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use freya_hooks::{
};
use winit::window::CursorIcon;

/// [`DropdownItem`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct DropdownItemProps<T: 'static + Clone + PartialEq> {
/// Theme override.
Expand Down Expand Up @@ -118,6 +119,7 @@ where
)
}

/// [`Dropdown`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct DropdownProps<T: 'static + Clone + PartialEq> {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/gesture_area.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ pub enum Gesture {
DoubleTap,
}

/// [`GestureArea`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct GestureAreaProps {
/// Inner children for the GestureArea.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/graph.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ impl GraphLine {
}
}

/// [`Graph`] component properties.
#[derive(Debug, Props, PartialEq, Clone)]
pub struct GraphProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/input.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ pub enum InputStatus {
Hovering,
}

/// [`Input`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct InputProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/loader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use freya_hooks::{
use_animation, use_applied_theme, AnimNum, LoaderTheme, LoaderThemeWith, OnFinish,
};

/// [`Loader`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct LoaderProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/network_image.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use freya_hooks::{
use freya_node_state::dynamic_bytes;
use reqwest::Url;

/// [`NetworkImage`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct NetworkImageProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/progress_bar.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use freya_elements::elements as dioxus_elements;

use freya_hooks::{use_applied_theme, ProgressBarTheme, ProgressBarThemeWith};

/// [`ProgressBar`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct ProgressBarProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/scroll_views/scroll_view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use crate::{
manage_key_event, Axis, ScrollBar, ScrollThumb, SCROLL_SPEED_MULTIPLIER,
};

/// [`ScrollView`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct ScrollViewProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/scroll_views/virtual_scroll_view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use crate::{
manage_key_event, Axis, ScrollBar, ScrollThumb, SCROLL_SPEED_MULTIPLIER,
};

/// [`VirtualScrollView`] component properties.
#[derive(Props, Clone)]
pub struct VirtualScrollViewProps<
Builder: 'static + Clone + Fn(usize, &Option<BuilderArgs>) -> Element,
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/slider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use freya_hooks::{use_applied_theme, use_focus, use_node, use_platform, SliderTh
use tracing::info;
use winit::window::CursorIcon;

/// [`Slider`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct SliderProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/switch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use freya_hooks::{
};
use winit::window::CursorIcon;

/// [`Switch`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct SwitchProps {
/// Theme override.
Expand Down
4 changes: 4 additions & 0 deletions crates/components/src/table.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ fn TableArrow(order_direction: OrderDirection) -> Element {
})
}

/// [`TableHead`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct TableHeadProps {
/// The content of this table head.
Expand Down Expand Up @@ -49,6 +50,7 @@ pub fn TableBody(TableBodyProps { children }: TableBodyProps) -> Element {
)
}

/// [`TableRow`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct TableRowProps {
/// Theme override.
Expand Down Expand Up @@ -110,6 +112,7 @@ pub enum OrderDirection {
Down,
}

/// [`TableCell`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct TableCellProps {
/// The content of this cell.
Expand Down Expand Up @@ -174,6 +177,7 @@ pub fn TableCell(props: TableCellProps) -> Element {
)
}

/// [`Table`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct TableProps {
/// Theme override.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/theme.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use dioxus::prelude::*;
use freya_hooks::{use_init_theme, Theme};

/// [`ThemeProvider`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct ThemeProviderProps {
/// Theme to provide.
Expand Down
1 change: 1 addition & 0 deletions crates/components/src/tooltip.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use freya_elements::elements as dioxus_elements;

use freya_hooks::{use_applied_theme, TooltipTheme, TooltipThemeWith};

/// [`Tooltip`] component properties.
#[derive(Props, Clone, PartialEq)]
pub struct TooltipProps {
/// Theme override.
Expand Down

0 comments on commit 0487b42

Please sign in to comment.