|
| 1 | +--- |
| 2 | +title: Chat Module |
| 3 | +description: Display a custom AI chat panel within the Crowdin or Crowdin Enterprise UI |
| 4 | +slug: developer/crowdin-apps-module-chat |
| 5 | +sidebar: |
| 6 | + order: 21 |
| 7 | + label: Chat |
| 8 | +--- |
| 9 | + |
| 10 | +The chat module allows the creation of chat dialogs in the right side panel of the Crowdin or Crowdin Enterprise UI. The panel can be opened or closed using a button with the app's logo in the header next to the user's profile picture. |
| 11 | + |
| 12 | +## Access |
| 13 | + |
| 14 | +You can grant access to this module to one of the following user categories: |
| 15 | + |
| 16 | +For Crowdin: |
| 17 | + |
| 18 | +* Only me (i.e., project owner) |
| 19 | +* All project members |
| 20 | +* Selected users |
| 21 | + |
| 22 | +For Crowdin Enterprise: |
| 23 | + |
| 24 | +* Only organization admins |
| 25 | +* All users in the organization projects |
| 26 | +* Selected users |
| 27 | + |
| 28 | +## Structure |
| 29 | + |
| 30 | +```json title="manifest.json" |
| 31 | +{ |
| 32 | + "modules": { |
| 33 | + "chat": [ |
| 34 | + { |
| 35 | + "key": "your-module-key", |
| 36 | + "name": "Module name", |
| 37 | + "description": "Module description", |
| 38 | + "url": "/chat-page" |
| 39 | + } |
| 40 | + ] |
| 41 | + } |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +## Properties |
| 46 | + |
| 47 | +<table> |
| 48 | + <tbody> |
| 49 | + <tr> |
| 50 | + <td><code>key</code></td> |
| 51 | + <td> |
| 52 | + <p><strong>Type:</strong> <code>string</code></p> |
| 53 | + <p><strong>Required:</strong> yes</p> |
| 54 | + <p><strong>Description:</strong> Module identifier within the Crowdin app.</p> |
| 55 | + </td> |
| 56 | + </tr> |
| 57 | + <tr> |
| 58 | + <td><code>name</code></td> |
| 59 | + <td> |
| 60 | + <p><strong>Type:</strong> <code>string</code></p> |
| 61 | + <p><strong>Description:</strong> The human-readable name of the module. Defaults to the app name if not specified.</p> |
| 62 | + </td> |
| 63 | + </tr> |
| 64 | + <tr> |
| 65 | + <td><code>description</code></td> |
| 66 | + <td> |
| 67 | + <p><strong>Type:</strong> <code>string</code></p> |
| 68 | + <p><strong>Description:</strong> The human-readable description of what the module does.<br/> |
| 69 | + The description will be visible in the Crowdin or Crowdin Enterprise UI.</p> |
| 70 | + </td> |
| 71 | + </tr> |
| 72 | + <tr> |
| 73 | + <td><code>url</code></td> |
| 74 | + <td> |
| 75 | + <p><strong>Type:</strong> <code>string</code></p> |
| 76 | + <p><strong>Required:</strong> yes</p> |
| 77 | + <p><strong>Description:</strong> The relative URL to the content page of the module that will be integrated into the Crowdin or Crowdin Enterprise UI.</p> |
| 78 | + </td> |
| 79 | + </tr> |
| 80 | + <tr> |
| 81 | + <td><code class="whitespace-nowrap">environments</code></td> |
| 82 | + <td> |
| 83 | + <p><strong>Type:</strong> <code>string</code></p> |
| 84 | + <p><strong>Allowed values:</strong> <code>crowdin</code>, <code>crowdin-enterprise</code></p> |
| 85 | + <p><strong>Description:</strong> Set of environments where a module could be installed.<br/> |
| 86 | + This parameter is needed for cross-product applications.</p> |
| 87 | + </td> |
| 88 | + </tr> |
| 89 | + </tbody> |
| 90 | +</table> |
0 commit comments