Crate freya_hooks
source ·Expand description
§Freya Hooks
A collection of hooks to be used in Freya.
Macros§
- Alias for
Cow::Borrowed, because that’s used a million times so shortening it is nice. Makes the code more readable. - Example usage:
- Create
FooThemeWithstructs without having to deal with the verbose syntax. - This macro has three arguments separator by commas.
Structs§
- Theming properties for the
Accordioncomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Animate a color.
- Animate a numeric value.
- Configuration for a given Asset.
- Theming properties for the
Bodycomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Buttoncomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Canvascomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Checkboxcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
DropdownItemcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Dropdowncomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Create a configuration for a
UseEditable. - Theming properties for Fonts.
- You can use this to change a theme for only one component, with the
themeproperty. Theming properties for Fonts. - Theming properties for the
Graphcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Iconcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Inputcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - A text line from a TextEditor
- Iterator over text lines.
- Theming properties for the
Linkcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Loadercomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
MenuContainercomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
MenuItemcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
NetworkImagecomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Information about the platform.
- Theming properties for the
Popupcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
ProgressBarcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Radiocomponent. - You can use this to change a theme for only one component, with the
themeproperty. - A utf8 text rope.
- TextEditor implementing a Rope
- Theming properties for the
ScrollBarcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
ScrollViewcomponent. Also used byVirtualScrollView. - You can use this to change a theme for only one component, with the
themeproperty. Also used byVirtualScrollView. - Theming properties for the
SidebarItemcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Sidebarcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Slidercomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
SnackBarcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Switchcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Tablecomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Holds the position of a cursor in a text
- Events for TextEditor
- Theming properties for the
Tilecomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Theming properties for the
Tooltipcomponent. - You can use this to change a theme for only one component, with the
themeproperty. - Pass uniform values to a Shader.
- Animate your elements. Use
use_animationto use this. - Holds a rendering hook callback that allows to render to the Canvas.
- Manage an editable content.
- Manage the focus operations of given Node
Enums§
- Controls the direction of the animation.
- Defines the duration for which an Asset will remain cached after it’s user has stopped using it. The default is 1h (3600s).
- Events emitted to the
UseEditable. - How the editable content must behave.
- What to do once the animation finishes. By default it is
Stop - Uniform value to be passed to a Shader.
Constants§
Traits§
- Common trait for editable texts
Functions§
- Animate your elements easily.
- Global caching system for assets.
- Register a rendering hook to gain access to the Canvas.
- Create a virtual text editor with it’s own cursor and rope.
- Create a focus manager for a node.
- Sync both the Focus shared state and the platform accessibility focus
- Provide the default
Theme. - Provide a custom
Theme. - Subscribe to a Node layout changes.
- Get a signal to read the latest layout from a Node.
- Get access to information and features of the platform.
- Subscribe to
Themechanges.