1.4.0 • Published 4 months ago

@notificationapi/react v1.4.0

Weekly downloads
-
License
-
Repository
-
Last release
4 months ago

NotificationAPI

The React SDK is mainly used for displaying In-App Notifications, allowing users to see and change their Notification Preferences and enabling web push notification .

Docs

Please refer to our documentations.

Debug Mode

The SDK includes a comprehensive debug mode to help troubleshoot issues and understand SDK behavior. Enable it by adding the debug prop:

<NotificationAPIProvider
  clientId="your-client-id"
  userId="your-user-id"
  debug={true}
>
  {/* Your app components */}
</NotificationAPIProvider>

For detailed information about debug mode, see DEBUG.md.

Development

  1. Install dependencies:
npm install
  1. Run the example application:
npm run dev

The example application includes a debug mode toggle to demonstrate the feature.

React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

  • Configure the top-level parserOptions property like this:
export default {
  // other rules...
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname
  }
};
  • Replace plugin:@typescript-eslint/recommended to plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked
  • Optionally add plugin:@typescript-eslint/stylistic-type-checked
  • Install eslint-plugin-react and add plugin:react/recommended & plugin:react/jsx-runtime to the extends list

Contributing

We welcome contributions! To ensure smooth collaboration, please follow these steps:

  1. Clone the Repository

    • Fork the repository to your GitHub account.
    • Clone it to your local machine:

      git clone https://github.com/your-username/repo-name.git
      cd repo-name
  2. Create a Branch

    • Create a new branch for your changes:

      git checkout -b your-branch-name
  3. Make Your Changes

    • Make your changes in the relevant files.
    • Thoroughly test your changes to ensure they work as expected.
  4. Versioning

    • Before committing your changes, update the package version by running:

      npm version <type>
    • Versioning Types:

      • major: For breaking changes or large-scale features.
      • minor: For adding functionality in a backwards-compatible manner.
      • patch: For backwards-compatible bug fixes or small improvements.
    • For example, to update a patch version:

      npm version patch
  5. Commit and Push

    • Once you've made and tested your changes, commit them with a meaningful message:

      git add .
      git commit -m "Describe your changes"
    • Push your branch to GitHub:

      git push origin your-branch-name
  6. Submit a Pull Request

    • Create a pull request (PR) on GitHub.
    • Provide a clear description of what your changes do.
    • Link any relevant issues.
  7. Update Documentation

    • If your changes affect the documentation, please update it accordingly.
    • You can find the documentation repository here: NotificationAPI Docs.

Thank you for contributing!

1.2.0

5 months ago

1.0.2

8 months ago

1.0.1

9 months ago

1.0.0

9 months ago

1.4.0

4 months ago

1.0.3

8 months ago

0.0.37

11 months ago

0.0.36

12 months ago

1.1.1

7 months ago

1.1.0

7 months ago

1.1.4

5 months ago

1.1.3

5 months ago

1.3.0

5 months ago

1.1.2

6 months ago

0.0.34

12 months ago

0.0.35

12 months ago

0.0.33

12 months ago

0.0.30

1 year ago

0.0.31

1 year ago

0.0.32

1 year ago

0.0.29

1 year ago

0.0.28

1 year ago

0.0.27

1 year ago

0.0.26

1 year ago

0.0.25

1 year ago

0.0.24

1 year ago

0.0.23

1 year ago

0.0.22

1 year ago

0.0.21

1 year ago

0.0.20

1 year ago

0.0.19

1 year ago

0.0.18

1 year ago

0.0.17

1 year ago

0.0.16

1 year ago

0.0.15

1 year ago

0.0.14

1 year ago

0.0.13

1 year ago

0.0.12

1 year ago

0.0.11

1 year ago

0.0.10

1 year ago

0.0.9

1 year ago

0.0.8

1 year ago

0.0.7

1 year ago

0.0.6

1 year ago

0.0.5

1 year ago

0.0.4

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago