Crate freya_components

Freya Components

A collection of basic components to be used in Freya.

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.

ArrowIconProps

Properties for the ArrowIcon component.

BodyProps

Properties for the Body component.

ButtonProps

Properties for the Button component.

CanvasProps

Properties for the Canvas component.

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.

GestureAreaProps

Properties for the GestureArea component.

GraphLine

Data line for the Graph component.

GraphProps

Properties for the Graph component.

InputProps

Properties for the Input component.

KeyboardNavigatorProps

Properties for the KeyboardNavigator component.

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.

NativeRouterProps

Properties for the NativeRouter component.

NetworkImageProps

Properties for the NetworkImage 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.

ScrollBarProps

Properties for the ScrollBar component.

ScrollThumbProps

Properties for the ScrollThumb component.

ScrollViewProps

Properties for the ScrollView 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.

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.

ThemeProviderProps

Properties for the ThemeProvider component.

TickIconProps

Properties for the TickIcon component.

TileProps

Properties for the Tile component.

TooltipProps

Properties for the Tooltip component.

UseForm

Form controller

VirtualScrollViewProps

Properties for the VirtualScrollView component.

Enums

AccordionStatus

Indicates the current status of the accordion.

ButtonStatus

Identifies the current status of the Button.

CursorIcon

Describes the appearance of the (usually mouse) cursor icon.

DropdownItemStatus

Current status of the DropdownItem.

DropdownStatus

Current status of the Dropdown.

Gesture

Gesture emitted by the GestureArea component.

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.

SliderStatus

Describes the current status of the Slider.

SwitchStatus

Describes the current status of the Switch.

TileStatus

Indicates the current status of the Tile.

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

Provide a context to the inner components so they can know whether the passed route is the current router in the Router or not.

ArrowIcon

Icon component for an Arrow.

Body

Usually used to wrap the application root component.

Button

Clickable button.

Canvas

Draw anything inside of this canvas.

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

GestureArea

Detect complex touch gestures such as Gesture::DoubleTap.

Graph

Graph component.

Input

Small box to edit text.

KeyboardNavigator

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

NativeRouter

Provides native functionalities for a dioxus-router.

NetworkImage

Image component that automatically fetches and caches remote (HTTP) images.

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.

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.

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.

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.

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

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.

manage_key_event

use_form

Create a Form controller with a submit callback.