v1.0.0
Release Note
We are excited to announce the launch of User Experience Portal (UXP) is a robust visualization tool crafted to innovate dashboard creation and customization. UXP equips developers with a wide list of reusable components and functionalities, enabling them to effortlessly construct dynamic widgets and visualizations in mere minutes.
Key Features:
Reusable Components: UXP provides a rich library of reusable components and functionalities, giving developers a robust framework to craft customizable widgets and visualizations tailored to their precise requirements.
Flexible Widget Building: With UXP, developers can effortlessly construct widgets and sidebar links that seamlessly integrate into dashboards. Moreover, the platform offers the versatility to design custom interfaces, enabling developers to deliver distinctive user experiences.
Third-Party Library Integration: UXP empowers developers to harness any custom third-party libraries to enrich their visualizations and expand functionality, unlocking boundless opportunities for innovation and creativity.
Components, hooks, and functions
UXP provides an extensive range of components and hooks to cater to various needs, including:
Components:
PortalContainer
Tooltip
DropDownButton
Popover
Modal
ModalWizard
FilterPanel
Wizard
FormField
FormFeedback
Label
Input
Checkbox
Select
MultiSelect
DynamicSelect
DatePicker
DateRangePicker
TimePicker
TimeRangePicker
DateTimePicker
SearchBox
CalendarComponent
ColorPicker
TitleBar
LinkWidgetContainer
Loading
NotificationBlock
ToggleFilter
ProfileImage
DataList
DataTable
DataGrid
HorizontalScrollList
ItemCard
ItemListCard
WidgetWrapper
MapComponent
Button
AsyncButton
IconButton
ConfirmButton
LinkButtonWidget
DefaultLoader
BarChartLoader
DonutChartLoader
GaugeLoader
HeatmapChartLoader
PieChartComponent
TrendChartComponent
RadialGauge
Hooks:
useToast
useMessageBus
useFields
useResizeEffect
useUpdateWidgetProps
useEffectWithPolling
useEventSubscriber
Functions:
eventDispatcher
This comprehensive collection empowers developers to create versatile and feature-rich user experiences within the UXP framework.
UXP Context:
Within the UXP context, developers gain access to essential functions and variables facilitating seamless integration and customization. These include:
executeAction: Executes any Lucy model action.
executeService: Executes any services in Lucy
executeRenderUI: Enables rendering of custom UI within any widget, offering flexibility in designing user interfaces tailored to specific needs.
lucyUrl: Stores the URL of the Lucy instance where the dashboard or interface is hosted, ensuring smooth communication with the Lucy platform.
apiKey: Stores the API key of the Lucy instance, granting authorized access to UXP functionalities and services.
userKey: Represents the current logged-in user's user key, providing personalized access and authentication within the UXP environment.
With its robust feature set and flexibility, UXP empowers developers to craft captivating dashboards and visualizations, enhancing user experiences to new heights. We eagerly anticipate the innovative solutions our community will create using UXP.
Additional Resources
UXP App (portal editor)
Portal editor is where you configure dashboards and other configurations
uxp.d.ts
Type definitions for the uxp components
Last updated