Utilities

Various utility classes for working with a UI and Redux.

Classes

Name Description  
PropsHelper A set of helper methods for various props Deprecated
ToolbarButtonHelper A set of Dom helper methods  
UiFramework Main entry point to configure and interact with the features provided by the AppUi-react package.  
UiVisibilityChangedEvent UiVisibility Event class. Deprecated
ViewUtilities Various View utility methods  

Constants

Name Description  
SafeAreaContext Context used to manage safe area (feature used by devices with non-rectangular screens).  

Enumerations

Name Description  
SafeAreaInsets Describes available safe area insets.  

Global Functions

Name Description  
PreviewFeaturesProvider Set which preview features are enabled.  
useConditionalValue Hook that allows to get a value that depends on some sync UI events.  

Interfaces

Name Description  
FrameworkVisibility visibility interface  
PreviewFeatures List of preview features that can be enabled/disabled.  
PreviewFeaturesProviderProps Props for PreviewFeaturesProvider.  
UiVisibilityEventArgs UiVisibility Event Args interface. Deprecated
UserSettingsProvider Interface to be implemented but any classes that wants to load their user settings when the UiStateEntry storage class is set.  

Type Aliases

Name Description  
Placement Identifies the placement of a given element.  
RectangleProps Describes 2d bounds.  
SizeProps Describes 2d dimensions.  

Last Updated: 19 September, 2024