@amityco/ui-kit v4.8.1
Amity UI-Kit for Web
Getting Started
Installation
Install Amity UI-Kit using either npm or yarn:
npm install --save @amityco/ui-kit
or
yarn add @amityco/ui-kit
Documentation
For detailed usage and API references, visit our official documentation or contact our support team at developers@amity.co.
Setting Up UI-Kit
To integrate Amity UI-Kit into your application, follow these steps:
Import the main UI-Kit styles (Required)
Add the following import statement in your main application file:import '@amityco/ui-kit/dist/index.css'; // **Required**
Customize UI-Kit (Optional)
If you want to customize component styles, create a configuration file namedamity-uikit.config.json
and define your theme colors.Wrap your application with
<AmityUiKitProvider>
In your main application component, wrap your content withAmityUiKitProvider
and pass the required configurations.
Example Integration
import React from 'react';
import "@amityco/ui-kit/dist/index.css";
import amityConfig from './amity-uikit.config.json';
import { AmityUiKitProvider, AmityUiKitSocial } from '@amityco/ui-kit';
const App = () => {
return (
<AmityUiKitProvider
apiKey={apiKey}
userId={userId}
displayName={displayName}
apiEndpoint={apiEndpoint}
apiRegion={apiRegion}
configs={amityConfig as Config}
>
<div
style={{
position: "absolute",
left: 0,
top: 0,
width: "100vw",
height: "100dvh",
}}
>
<AmityUiKitSocial />
</div>
</AmityUiKitProvider>
);
};
export default App;
Contributing
We welcome contributions! Please check our contributing guide for details.
6 months ago
8 months ago
9 months ago
8 months ago
5 months ago
5 months ago
6 months ago
6 months ago
11 months ago
11 months ago
9 months ago
10 months ago
8 months ago
8 months ago
6 months ago
6 months ago
11 months ago
11 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
11 months ago
9 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago