4.8.1 • Published 5 months ago

@amityco/ui-kit v4.8.1

Weekly downloads
-
License
LGPL-2.1-only
Repository
-
Last release
5 months ago

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:

  1. 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**
  2. Customize UI-Kit (Optional)
    If you want to customize component styles, create a configuration file named amity-uikit.config.json and define your theme colors.

  3. Wrap your application with <AmityUiKitProvider>
    In your main application component, wrap your content with AmityUiKitProvider 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.

3.13.1

6 months ago

3.12.0

8 months ago

4.0.1

9 months ago

5.0.0

8 months ago

4.8.1

5 months ago

4.8.0

5 months ago

3.13.0

6 months ago

4.7.0

6 months ago

3.11.4

11 months ago

3.11.3

11 months ago

3.11.6

9 months ago

3.11.5

10 months ago

3.11.8

8 months ago

3.11.7

8 months ago

4.6.1

6 months ago

4.6.0

6 months ago

3.11.2

11 months ago

3.11.1

11 months ago

4.5.0

7 months ago

4.4.1

7 months ago

4.4.0

7 months ago

4.4.2

7 months ago

4.3.0

8 months ago

4.2.1

8 months ago

4.2.0

8 months ago

4.0.0-beta.18

11 months ago

4.1.0

9 months ago

3.11.0

12 months ago

4.0.0-beta.17

12 months ago

4.0.0-beta.16

12 months ago

3.10.2

12 months ago

4.0.0-beta.15

1 year ago

4.0.0-beta.14

1 year ago

3.10.1

1 year ago

3.10.0

1 year ago

4.0.0-beta.13

1 year ago

4.0.0-beta.12

1 year ago

4.0.0-alpha.0

1 year ago

3.6.0

1 year ago

3.9.0

1 year ago

4.0.0-beta.11

1 year ago

3.8.0

1 year ago

4.0.0-beta.10

1 year ago

4.0.0-beta.8

1 year ago

4.0.0-beta.7

1 year ago

4.0.0-beta.6

1 year ago

4.0.0-beta.5

1 year ago

3.7.0

1 year ago

4.0.0-beta.9

1 year ago

4.0.0-beta.4

1 year ago

4.0.0-beta.3

1 year ago

3.5.0

1 year ago

4.0.0-beta.2

2 years ago

3.1.1-beta.0

2 years ago

3.4.0

2 years ago

4.0.0-beta.1

2 years ago

4.0.0-beta.0

2 years ago

4.0.0

2 years ago

3.3.0

2 years ago

3.2.4

2 years ago

3.2.3

2 years ago

3.2.1

2 years ago

3.2.0

2 years ago

3.1.2

2 years ago

3.1.1

2 years ago

3.1.0

2 years ago

3.0.0

2 years ago

2.16.1

2 years ago

2.16.0

2 years ago

2.15.8

2 years ago

2.15.7

2 years ago

2.15.6

3 years ago

2.15.4

3 years ago

2.15.5

3 years ago

2.15.3

3 years ago

2.14.5

3 years ago

2.14.6

3 years ago

2.15.2

3 years ago

2.14.4

3 years ago

2.15.0

3 years ago

2.15.1

3 years ago

2.14.3

3 years ago

2.14.1

3 years ago

2.14.2

3 years ago

2.14.0

3 years ago

2.12.3

3 years ago

2.13.0

3 years ago

2.12.1

3 years ago

2.12.2

3 years ago

2.12.0

3 years ago

2.11.0

4 years ago

2.11.1

3 years ago

2.10.0

4 years ago

2.9.1

4 years ago

2.5.0

4 years ago

2.7.0

4 years ago

2.6.0

4 years ago

2.9.0

4 years ago

2.8.0

4 years ago

2.4.0

4 years ago

2.3.0

4 years ago

2.2.0

4 years ago

2.1.0

4 years ago

2.1.0-rc.2

4 years ago

2.1.0-rc.1

4 years ago

2.1.0-rc.0

4 years ago

2.0.1-pm-rc12

4 years ago

2.0.1-pm-rc11

4 years ago

2.0.1-pm-rc10

4 years ago

2.0.1-pm-rc9

4 years ago

2.0.1-pm-rc8

4 years ago

2.0.1-pm-rc7

4 years ago

2.0.1-pm-rc6

4 years ago

2.0.1-pm-rc5

4 years ago

2.0.1-pm-rc4

4 years ago

2.0.1-pm-rc3

4 years ago

2.0.1-pm-rc2

4 years ago

2.0.1-pm-rc1

4 years ago

2.0.1

4 years ago

1.9.0

4 years ago

1.8.1

4 years ago