useAwsui

use-awsui is a collection of React hooks for the AWS UI components. By instantiating your components' local state with this library, you can save repetitive boilerplate surrounding state instantiation and event handlers. You may also rest comfortably knowing this package maintains 100% test coverage.

• Install
• Supported components
• React Router
• Contributing

Install

• npm install use-awsui or
• yarn add use-awsui

Supported components

The use-awsui library offers React hooks for the following AWS UI components. These hooks return several of the components' value props and event handlers in order to both instantiate and manage the components' local, controlled state.

• Alert
• AppLayout
• Checkbox
• CollectionPreferences
• ExpandableSection
• Input
• Pagination
• RadioGroup
• SideNavigation
• Table
• Tabs
• TextFilter
• Toggle

React Router

AWS UI components do not support React Router out-of-the-box. If you are looking for hooks that integrate with React Router, it is recommended that you use this library in tandem with use-awsui-router.

Contributing

To install this repository to begin local development, use the following commands in order:

• yarn set version latest to keep Yarn up-to-date.
• yarn to install the existing dependencies.
• yarn up * && yarn up @*/* to upgrade to the latest dependencies.
• yarn dlx @yarnpkg/pnpify --sdk vscode to integrate with VS Code.