@link-loom/ui-sdk

Description

The @link-loom/ui-sdk is a collection of React-based UI components designed to aid in the development of web applications. This library includes a variety of user interface elements ranging from simple alerts and spinners to more complex components like document viewers and data grids, providing developers with essential tools to create intuitive and engaging user interfaces.

Installation

Install the library in your project with the following command:

npm install @link-loom/ui-sdk

Components

• Alert: Displays a brief, important message to the user in various styles to signify success, warning, error, or information.
• DataGrid: A versatile grid component capable of displaying large sets of data, supporting sorting, filtering, and pagination.
• DocumentViewer: Renders documents directly within your application, supporting formats like PDF, Word, and more.
• OffCanvas: Provides a hidden side panel that slides in and out from the edge of the viewport, useful for menus, filters, or additional information.
• PageLoaded: A utility component that tracks the loading state of a page or section, providing visual feedback to the user.
• Placeholder: Generates placeholder elements to use during content loading, enhancing the user experience by indicating where content will appear.
• PopUp: Displays modal dialogs or pop-up windows, suitable for alerts, prompts, and custom dialogs.
• SearchableSelect: A select dropdown component with integrated search functionality, allowing users to filter options as they type.
• Spinner: Offers visual cues for loading states, with customizable animations and styles.
• LabelTags: Displays tags or labels, useful for categorization, highlighting key information, or filtering content.
• SelectizeTags: Combines tag display and selection, allowing users to create and select tags within an input field.
• SelectorTag: Provides a tag-based selection interface, enabling users to choose from a predefined set of tags.
• TextEditor: A rich text editor component that provides a wide range of formatting options for text content.
• Uploader: Facilitates file uploads, showing progress, and providing feedback to the user.

For more details on each component, including usage and configuration options, please refer to the full documentation.

Documentation

For detailed information on each component, including the props they accept and the events they emit, refer to the comprehensive documentation provided with the library.

Contributions

Contributions to the library are welcome. If you wish to contribute, please review the contribution guidelines provided in the repository.

License

This project is licensed under the Apache License. For more details, see the LICENSE file in the repository.