@bigbinary/neeto-team-members-frontend 2.10.6 → 2.10.8

package/README.md

@@ -2,22 +2,27 @@
 
 The `neeto-team-members-nano` facilitates the administration of team members within neeto applications. The nano exports the `@bigbinary/neeto-team-members-frontend` NPM package and `neeto-team-members-engine` Rails engine for development.
 
-# Contents
+## Contents
+
 1. [Development with Host Application](#development-with-host-application)
     - [Engine](#engine)
-      * [Installation](#installation)
-      * [Usage](#usage)
+      - [Installation](#installation)
+      - [Usage](#usage)
     - [Frontend package](#frontend-package)
-      * [Installation](#installation-1)
-      * [Components](#components)
+      - [Installation](#installation-1)
+      - [Components](#components)
 2. [Instructions for Publishing](#instructions-for-publishing)
 
-# Development with Host Application
-## Engine
+## Development with Host Application
+
+### Engine
+
 The engine is used to seed the roles and permissions for the organization. It also provides concerns to handle common logic related to `User` model.
 
-### Installation
+#### Installation
+
 1. Add this line to your application's Gemfile:
+
    ```ruby
     source "NEETO_GEM_SERVER_URL" do
       # ..existing gems
@@ -25,51 +30,75 @@ The engine is used to seed the roles and permissions for the organization. It al
       gem 'neeto-team-members-engine'
     end
    ```
+
 2. And then execute:
+
    ```shell
    bundle install
    ```
+
 3. Add this line to your application's `config/routes.rb` file:
+
    ```ruby
     mount NeetoTeamMembersEngine::Engine => "/neeto_team_members_engine"
    ```
+
 4. Run the command to bring in all migrations required from the engine to the host application:
+
    ```shell
    bundle exec rails neeto_team_members_engine:install:migrations
    ```
+
 5. Add the migrations to the database:
+
    ```shell
    bundle exec rails db:migrate
    ```
+
 6. Now, run the generator which will copy the required files.
+
    ```shell
    bundle exec rails g neeto_team_members_engine:install
    ```
+
    This command will try to inject the engine's route as well as create a `config/permissions.yml` file to add the permissions required.
 
-### Usage
+#### Usage
+
 You can learn more about the setup and usage here:
+
 1. [Permissions](./docs/engine/permissions.md)
 2. [Roles](./docs/engine/roles.md)
 3. [Concerns](./docs/engine/concerns.md)
 
-## Frontend package
+### Frontend package
+
 The package exports the four components: `Roles`, `TeamMembers`, `Permissions`, and `ManageRole`.
 
-### Installation
-Install the latest `NeetoTeamMembersnano` package using the below command:
+#### Installation
+
+Install the latest `NeetoTeamMembersNano` package using the below command:
 
 ```shell
 yarn add @bigbinary/neeto-team-members-frontend
 ```
-### Components
-#### `Roles`
+
+#### Components
+
+##### `Roles`
+
 This component manages team roles. It includes functionalities such as adding roles and allowing updates to roles with associated permissions.
-##### Props
+
+###### Props
+
 - `config`: Configuration object that includes mandatory specifications for header breadcrumbs and role permissions. It also allows optional configurations for help articles and permission hierarchy.
-##### Configuration
+
+###### Configuration
+
 Refer to the [Roles](./docs/frontend/roles.md) section for detailed information on the available configurations for the `Roles` component.
-##### Usage
+
+###### Usage
+
 ```jsx
 import React from "react";
 
@@ -95,13 +124,21 @@ const App = () => (
 
 export default App;
 ```
-#### `TeamMembers`
+
+##### `TeamMembers`
+
 The component offers functionalities for adding, updating and viewing team members and their roles in a tabular format. Additionally, it provides filtering options based on email, name, and role.
-##### Props
+
+###### Props
+
 - `config`: Configuration object that allows customization of role management, member operation permissions, UI elements like buttons and headers, callback functions, table structure, dropdown actions, and various display aspects.
-##### Configuration
+
+###### Configuration
+
 Refer to the [TeamMembers](./docs/frontend/team_members.md) section for detailed information on the available configurations for the `TeamMembers` component.
-##### Usage
+
+###### Usage
+
 ```jsx
 import React from "react";
 
@@ -128,15 +165,22 @@ const App = () => (
 export default App;
 ```
 
-#### `Permissions`
+##### `Permissions`
+
 The component handles the rendering and management of permissions for team members. It organizes permissions into categories, provides checkboxes for selection, and supports hierarchical structures with parent-child relationships.
-##### Props
+
+###### Props
+
 - `permissions`: An array of permissions.
 - `isDisabled`: A boolean indicating whether the component is disabled. By default, it is false.
 - `permissionRelationConfig`: Configuration for managing parent-child relationships and unchecking permissions on select.
-##### Configuration
+
+###### Configuration
+
 Refer to the [Permissions](./docs/frontend/permissions.md) section for detailed information on the available configurations for the `TeamMembers` component.
-##### Usage
+
+###### Usage
+
 ```jsx
 import React from "react";
 
@@ -166,18 +210,24 @@ const App = () => (
 export default App;
 ```
 
-#### `ManageMembers`
+##### `ManageMembers`
+
 The component is a form-based interface for adding or editing team members.
-##### Props
+
+###### Props
+
 - `config`: Configuration object with various options for customizing the behavior of the component.
 - `onComplete`: Callback function to be executed when the component is closed or the form is submitted.
 - `roles`: An array of roles available for team members.
 - `selectedMember`: The team member object being edited, if applicable.
 - `componentConfig`: Configuration specific to the component, including the type of pane, initial focus reference, etc.
 
-##### Configuration
+###### Configuration
+
 Refer to the [ManageMembers](./docs/frontend/manage_members.md) section for detailed information on the available configurations for the `ManageMembers` component.
-##### Usage
+
+###### Usage
+
 ```jsx
 import React from "react";
 
@@ -207,6 +257,40 @@ const App = () => (
 
 export default App;
 ```
-# Instructions for Publishing
+
+## Instructions for Publishing
 
 Consult the [building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide for details on how to publish.
+
+## Integrations
+
+| Projects       | TeamMembers        | Roles              | Permissions        |
+|----------------| :----------------: | :----------------: | :----------------: |
+| neetoAuth      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoCal       | :white_check_mark: | :white_check_mark: |         -          |
+| neetoChangelog | :white_check_mark: | :white_check_mark: |         -          |
+| neetoChat      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoChatify   | :white_check_mark: | :white_check_mark: |         -          |
+| neetoCI        | :white_check_mark: | :white_check_mark: |         -          |
+| neetoCourse    | :white_check_mark: | :white_check_mark: |         -          |
+| neetoCRM       | :white_check_mark: | :white_check_mark: |         -          |
+| neetoDeploy    | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| neetoDesk      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoForm      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoGit       | :white_check_mark: | :white_check_mark: |         -          |
+| neetoInvisible | :white_check_mark: | :white_check_mark: |         -          |
+| neetoInvoice   | :white_check_mark: | :white_check_mark: |         -          |
+| neetoKB        | :white_check_mark: | :white_check_mark: |         -          |
+| neetoMonitor   | :white_check_mark: | :white_check_mark: |         -          |
+| neetoPlanner   | :white_check_mark: | :white_check_mark: |         -          |
+| neetoQuiz      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoRecord    | :white_check_mark: | :white_check_mark: |         -          |
+| neetoReplay    | :white_check_mark: | :white_check_mark: |         -          |
+| neetoRunner    | :white_check_mark: | :white_check_mark: |         -          |
+| neetoSign      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoSite      | :white_check_mark: | :white_check_mark: |         -          |
+| neetoTestify   | :white_check_mark: | :white_check_mark: |         -          |
+| neetoTower     | :white_check_mark: | :white_check_mark: |         -          |
+| neetoTrail     | :white_check_mark: | :white_check_mark: |         -          |
+| neetoWheel     | :white_check_mark: | :white_check_mark: |         -          |
+| neetoWireframe | :white_check_mark: | :white_check_mark: |         -          |