Install
Works with Drupal: ^10.3 || ^11Using dev releases is not recommended, except for testing.
Using Composer to manage Drupal site dependencies
Alternative installation files
Download tar.gz
15.57 KB
MD5: c698843f3b197f6ae040a69c44a8c25f
SHA-1: 2219a4c291ac8b40013411a7e40ee8474d392e56
SHA-256: 48207c102227e9c52f157f91e23aaa33706241210f01fcb466007b923584f9f4
Download zip
21.61 KB
MD5: e614a13adaef397f8012aeb626370994
SHA-1: a2528e4ba527cbc29825f2275bbd1e769d85364a
SHA-256: 08684a80e2cdc3154db5454c1accbc998fef4542a6c9b175c7ace43daad43c53
Release notes
First public development release of ChatClient.ai, extracted from the module that runs the chatclient.ai widget. Supports Drupal 10.3+ and Drupal 11. Tracks the 1.0.x branch; expect changes before 1.0.0.
What's in this release
- Public pages only. The widget is attached on every page an anonymous visitor sees and never on
/user/*,/admin*, or any page viewed by an authenticated user. These exclusions are hardcoded. - On/off switch. Configuration → Web services → ChatClient.ai turns the widget off and on without a deployment. Saving invalidates the page cache through the config cache tag.
- Chatbot ID in configuration. Stored in
chatclient_ai.settings. An empty ID hides the widget. - Path exclusions with wildcards. One pattern per line, same syntax as block visibility's Pages field (
*,<front>, matched against alias and system path). Additive to the hardcoded exclusions. - Accessibility fixes for the vendor markup. The launcher and mobile close control become labelled, keyboard-operable buttons with
aria-expandedkept in sync; icons are marked decorative; the chat iframe gets a title. - Configurable labels.
launcher_label(default "Open chat") andchat_title(default "Chat") set the accessible name of the launcher and the iframe title.
Install and configure
composer require drupal/chatclient_ai drush en chatclient_ai drush cset chatclient_ai.settings chatbot_id YOUR_ID -y
Or enter the ID at /admin/config/services/chatclient-ai. The administer chatclient_ai permission is restricted.
Known limitations
- If your deployment imports configuration, add
chatclient_ai.settingsto Config Ignore or the on/off switch is reset on everydrush cim. - When the module is first installed by a config import, no
chatclient_ai.settingsexists afterwards. Save the settings form once, or create the object from ahook_deploy_NAME(). - No automated tests ship with the module yet.
- The accessibility patch relies on element IDs the vendor embed sets. A change on the vendor side may require an update.