Skip to content

Automattic/chatrix

Repository files navigation

Chatrix

Matrix client for WordPress.

Description

Easily add a Matrix client to WordPress pages, either through the Block Editor, or as a popup.

Screenshots

Block Popup

Frequently Asked Questions

How can I install this plugin on my site?

This plugin can be used in two distinct ways:

  1. By adding a block to a page through the block editor
  2. By selecting pages in which a popup will be displayed. You configure this through Settings -> Chatrix.

Is there a more flexible way to configure the popup?

Yes. Instead of configuring the popup through Settings -> Chatrix, you can configure it through code, by using the chatrix_instances filter:

` // functions.php

add_filter( 'chatrix_instances', function ( array $default_instances ) { // The key is an instance_id, the value array is the config for that instance. // Set 'pages' to an array of the ids of the pages which should show chatrix. // You can also set 'pages' to 'all' which results in that instance always being used. // Only one instance can be shown on a given page. return array( 'foo' => array( 'homeserver' => 'https://foo.com', 'room_id' => '!id:foo.com', 'pages' => 'all', ), 'bar' => array( 'homeserver' => 'https://bar.com', 'room_id' => '!id:bar.com', 'pages' => array(1, 2, 3), ), ); } ); `

How can I add a border around the block?

To add a border around the Chatrix block, you can place it inside a Group block. The Group block allows you to set a border, rounded corners, and other styling properties.