Crate freya_components

Source

Expand description

§Freya Components

A collection of basic components to be used in Freya.

Go to Gallery to see previews of the components.

Re-exports§

pub use ActivableRoute_completions::Component::ActivableRoute;
pub use AnimatedPosition_completions::Component::AnimatedPosition;
pub use Checkbox_completions::Component::Checkbox;
pub use GlobalAnimatedPosition_completions::Component::GlobalAnimatedPosition;
pub use Link_completions::Component::Link;
pub use Menu_completions::Component::Menu;
pub use MenuItem_completions::Component::MenuItem;
pub use SubMenu_completions::Component::SubMenu;
pub use MenuButton_completions::Component::MenuButton;
pub use MenuContainer_completions::Component::MenuContainer;
pub use NativeContainer_completions::Component::NativeContainer;
pub use NativeRouter_completions::Component::NativeRouter;
pub use OverflowedContent_completions::Component::OverflowedContent;
pub use PopupBackground_completions::Component::PopupBackground;
pub use Popup_completions::Component::Popup;
pub use PopupTitle_completions::Component::PopupTitle;
pub use PopupContent_completions::Component::PopupContent;
pub use Radio_completions::Component::Radio;
pub use ResizableContainer_completions::Component::ResizableContainer;
pub use ResizablePanel_completions::Component::ResizablePanel;
pub use ResizableHandle_completions::Component::ResizableHandle;
pub use SelectableText_completions::Component::SelectableText;
pub use Sidebar_completions::Component::Sidebar;
pub use SidebarItem_completions::Component::SidebarItem;
pub use SnackBar_completions::Component::SnackBar;
pub use SnackBarBox_completions::Component::SnackBarBox;
pub use Tabsbar_completions::Component::Tabsbar;
pub use Tab_completions::Component::Tab;
pub use BottomTab_completions::Component::BottomTab;
pub use Tile_completions::Component::Tile;
pub use TooltipContainer_completions::Component::TooltipContainer;
pub use WindowDragArea_completions::Component::WindowDragArea;

Macros§

import_image: Generate a Dioxus component rendering the specified image.
import_svg: Generate a Dioxus component rendering the specified SVG.

Structs§

AccordionBodyProps: Properties for the AccordionBody component.
AccordionProps: Properties for the Accordion component.
AccordionSummaryProps: Properties for the AccordionSummary component.
ActivableRouteProps: Properties for the ActivableRoute component.
AnimatedPositionProps: Properties for the AnimatedPosition component.
AnimatedRouterProps
ArrowIconProps: Properties for the ArrowIcon component.
BaseButtonProps: Properties for the Button component.
BodyProps: Properties for the Body component.
BottomTabProps: Properties for the BottomTab component.
ButtonProps: Properties for the Button, FilledButton and OutlineButton components.
CheckboxProps: Properties for the Checkbox component.
CrossIconProps: Properties for the CrossIcon component.
CursorAreaProps: Properties for the CursorArea component.
DragProviderProps: Properties for the DragProvider component.
DragZoneProps: Properties for the DragZone component.
DropZoneProps: Properties for the DropZone component.
DropdownItemProps: Properties for the DropdownItem component.
DropdownProps: Properties for the Dropdown component.
FlatItem: Just like a TreeItem for flattened. Use this when rendering the items.
GestureAreaProps: Properties for the GestureArea component.
GlobalAnimatedPositionProps: Properties for the GlobalAnimatedPosition component.
GlobalAnimatedPositionProvider
GlobalAnimatedPositions
GraphLine: Data line for the Graph component.
GraphProps: Properties for the Graph component.
InputProps: Properties for the Input component.
InputValidator
LinkProps: Properties for the Link component.
LoaderProps: Properties for the Loader component.
MenuButtonProps: Properties for the MenuButton component.
MenuContainerProps: Properties for the MenuContainer component.
MenuItemProps: Properties for the MenuItem component.
MenuProps: Properties for the Menu component.
NativeContainerProps: Properties for the NativeContainer component.
NativeRouterProps: Properties for the NativeRouter component.
NetworkImageProps: Properties for the NetworkImage component.
OverflowedContentProps: Properties for the OverflowedContent component.
PopupBackgroundProps: Properties for the PopupBackground component.
PopupContentProps: Properties for the PopupContent component.
PopupProps: Properties for the Popup component.
PopupTitleProps: Properties for the PopupTitle component.
ProgressBarProps: Properties for the ProgressBar component.
RadioProps: Properties for the Radio component.
ResizableContainerProps: Properties for the ResizableContainer component.
ResizableHandleProps: Properties for the ResizableHandle component.
ResizablePanelProps: Properties for the ResizablePanel component.
ScrollBarProps: Properties for the ScrollBar component.
ScrollConfig
ScrollController
ScrollRequest
ScrollThumbProps: Properties for the ScrollThumb component.
ScrollViewProps: Properties for the ScrollView component.
SelectableTextProps: Properties for the SelectableText component.
SidebarItemProps: Properties for the SidebarItem component.
SidebarProps: Properties for the Sidebar component.
SliderProps: Properties for the Slider component.
SnackBarBoxProps: Properties for the [SnackBarBox] component.
SnackBarProps: Properties for the SnackBar component.
SubMenuProps: Properties for the SubMenu component.
SwitchProps: Properties for the Switch component.
TabProps: Properties for the Tab component.
TableBodyProps: Properties for the TableBody component.
TableCellProps: Properties for the TableCell component.
TableHeadProps: Properties for the TableHead component.
TableProps: Properties for the Table component.
TableRowProps: Properties for the TableRow component.
TabsbarProps: Properties for the Tabsbar component.
ThemeProviderProps: Properties for the ThemeProvider component.
TickIconProps: Properties for the TickIcon component.
TileProps: Properties for the Tile component.
TooltipContainerProps: Properties for the TooltipContainer component.
TooltipProps: Properties for the Tooltip component.
UseForm: Form controller
VirtualScrollViewProps: Properties for the VirtualScrollView component.
WindowDragAreaProps: Properties for the WindowDragArea component.

Enums§

AccordionStatus: Indicates the current status of the accordion.
AnimatedRouterContext
ButtonStatus: Identifies the current status of the Button.
DropdownItemStatus: Current status of the DropdownItem.
DropdownStatus: Current status of the Dropdown.
ExpandableItemState: Indicates the state of the item.
Gesture: Gesture emitted by the GestureArea component.
HandleStatus: Describes the current status of the Handle.
InputMode: Enum to declare is Input hidden.
InputStatus: Indicates the current status of the Input.
LinkTooltip: Tooltip configuration for the Link() component.
MenuItemStatus: Indicates the current status of the MenuItem.
OrderDirection: Sorting direction for items in Table.
PressEvent
ScrollDirection
ScrollPosition
SelectableTextStatus: Current status of the SelectableText.
SliderStatus: Describes the current status of the Slider.
SwitchStatus: Describes the current status of the Switch.
TabStatus: Current status of the Tab.
TileStatus: Indicates the current status of the Tile.
TooltipPosition
TreeItem: Item part of a larget Tree.

Traits§

ItemPath: Abstract the path matching.

Functions§

Accordion: Show other elements under a collapsable box.
AccordionBody: Intended to wrap the body of an Accordion.
AccordionSummary: Intended to use as summary for an Accordion.
ActivableRoute: Sometimes you might want to know if a route is selected so you can style a specific UI element in a different way, like a button with a different color. To avoid cluttering your components with router-specific code you might instead want to wrap your component in an ActivableRoute and inside your component call use_activable_route.
AnimatedPosition: Props
AnimatedRouter: Provide a mechanism for outlets to animate between route transitions.
ArrowIcon: Icon component for an Arrow.
Body: Usually used to wrap the application root component.
BottomTab: Clickable BottomTab. Same thing as Tab but designed to be placed in the bottom of your app, usually used in combination with Tabsbar, crate::Link and crate::ActivableRoute.
Button: Clickable button.
ButtonBase
Checkbox: Controlled Checkbox component.
CrossIcon: Icon component for a Cross.
CursorArea: Change the cursor icon when it’s hovering over this component.
DragProvider: Provide a common place for DragZones and DropZones to exchange their data.
DragZone: Make the inner children draggable to other DropZone.
DropZone: Elements from DragZones can be dropped here.
Dropdown: Select from multiple options, use alongside DropdownItem.
DropdownItem: Styling
FilledButton: Clickable button with a solid fill color.
GestureArea: Detect complex touch gestures such as Gesture::DoubleTap.
GlobalAnimatedPosition: Animate an element position across time and space.
GlobalAnimatedPositionProvider
Graph: Graph component.
Input: Small box to edit text.
Link: Similar to Link, but you can use it in Freya. Both internal routes (dioxus-router) and external links are supported. When using internal routes make sure the Link is descendant of a Router component.
Loader: Styling
Menu: Floating menu, use alongside MenuItem.
MenuButton: Like a button, but for Menus.
MenuContainer: Wraps the body of a Menu.
MenuItem: Styling
NativeContainer: Props
NativeRouter: Provides native functionalities for a dioxus-router.
NetworkImage: Image component that automatically fetches and caches remote (HTTP) images.
OutlineButton: Clickable button with an outline style.
OverflowedContent: Animate the content of a container when the content overflows.
Popup: Floating window intended for quick interactions. Also called Dialog in other frameworks.
PopupBackground: The background of the Popup component.
PopupContent: Optionally wrap the content of your Popup in a styled container.
PopupTitle: Optionally use a styled title inside a Popup.
ProgressBar: Display the progress of something visually. For example: downloading files, fetching data, etc.
Radio: Controlled Radio component.
ResizableContainer: Resizable container, used in combination with ResizablePanel() and ResizableHandle().
ResizableHandle: Resizable panel to be used in combination with ResizableContainer() and ResizablePanel().
ResizablePanel: Resizable panel to be used in combination with ResizableContainer() and ResizableHandle().
ScrollBar: Scroll bar used for crate::ScrollView and crate::VirtualScrollView.
ScrollThumb: Scroll thumb used for crate::ScrollView and crate::VirtualScrollView.
ScrollView: Scrollable area with bidirectional support and scrollbars.
SelectableText: Text that can be selected with a mouse or keyboard.
Sidebar: Props
SidebarItem: Props
Slider: Controlled Slider component.
SnackBar: SnackBar component. Use in combination with other components.
SubMenu: Create sub menus inside a Menu.
Switch: Display whether a state is true or false. Commonly used for enabled/disabled scenarios. Example: light/dark theme.
Tab: Clickable Tab. Usually used in combination with Tabsbar, crate::Link and crate::ActivableRoute.
Table: Table component, composed with TableHead and TableBody.
TableBody: The body of a Table.
TableCell: Cell for a Table. You can place anything inside.
TableHead: The head of a Table. Use TableRow inside.
TableRow: Table row for Table. Use TableCell inside.
Tabsbar: Horizontal container for Tabs. Use in combination with Tab
ThemeProvider: Provides a Theme for all its children.
TickIcon: Icon component for a Tick.
Tile: Tile component to be used with Radio and Checkbox.
Tooltip: Tooltip component. Use in combination with TooltipContainer().
TooltipContainer: TooltipContainer component.
VirtualScrollView: One-direction scrollable area that dynamically builds and renders items based in their size and current available size, this is intended for apps using large sets of data that need good performance.
WindowDragArea: Allow dragging the window when the cursor drag this component with a left mouse click.
gallery
manage_key_event
use_animated_router: Shortcut to get access to the AnimatedRouterContext.
use_form: Create a Form controller with a submit callback.
use_scroll_controller

Crate freya_components

Crate freya_components Copy item path

§Freya Components

Re-exports§

Macros§

Structs§

Enums§

Traits§

Functions§

Crate freya_components