Using Fcitx 5 on Wayland - Revision history

GalaxySnail: /* QT_IM_MODULE */ fix broken link

2025-09-20T15:59:16Z

QT_IM_MODULE: fix broken link

← Older revision		Revision as of 15:59, 20 September 2025
Line 83:		Line 83:
	So it will be able pick up the most usable one even for application that bundles no fcitx/wayland. Remember, you may still need to set( or unset) QT_IM_MODULE (not "QT_IM_MODULES") in order to handle Qt 4/5 applications.		So it will be able pick up the most usable one even for application that bundles no fcitx/wayland. Remember, you may still need to set( or unset) QT_IM_MODULE (not "QT_IM_MODULES") in order to handle Qt 4/5 applications.

	Qt 6.7 also brings text-input-v3 support, and there are some important fixes for text-input-v3 in the Qt 6.8 series ([https://bugreports.qt.io/issues/?jql=text%20input%20v3 related bugs]). If you are using a compositor that only supports text-input-v3, it should be OK to use text-input-v3 with Qt 6.8.2 or later.		Qt 6.7 also brings text-input-v3 support, and there are some important fixes for text-input-v3 in the Qt 6.8 series ([https://bugreports.qt.io/issues/?jql=text%20~%20%22text%20input%20v3%22 related bugs]). If you are using a compositor that only supports text-input-v3, it should be OK to use text-input-v3 with Qt 6.8.2 or later.

	=== Legacy X11 application that runs under XWayland === <!--T:24-->		=== Legacy X11 application that runs under XWayland === <!--T:24-->

GalaxySnail: Mention text-input-v3 support on Qt 6.8.2+

2025-09-20T15:53:19Z

Mention text-input-v3 support on Qt 6.8.2+

← Older revision		Revision as of 15:53, 20 September 2025
Line 66:		Line 66:

	==== QT_IM_MODULE ==== <!--T:19-->		==== QT_IM_MODULE ==== <!--T:19-->
	For QT_IM_MODULE, as for now QT can only use its own text-input-v{2,4}, which is only supported by KWin. Which means, under KDE you should unset it, but under other desktop, you will need to set it to QT_IM_MODULE=fcitx. Also the proprietary Qt applications in the wild complicates the situation. Some do not work on Wayland, some do not bundle/provide Qt wayland. Most of them do not bundle fcitx im module because fcitx is only a third party application to Qt, but I also noticed some do bundle but not bundle all the required libraries. While fcitx 5 support ibus protocol, some of those applications do not even bundle ibus im module. There are a few different environment variables you can try for those proprietary Qt applications (WPS, Anki, DaVinci Resolve, Mathematica, etc...).		For QT_IM_MODULE, as for now QT < 6.7 can only use its own text-input-v{2,4}, which is only supported by KWin. Which means, under KDE you should unset it, but under other desktop, you will need to set it to QT_IM_MODULE=fcitx. Also the proprietary Qt applications in the wild complicates the situation. Some do not work on Wayland, some do not bundle/provide Qt wayland. Most of them do not bundle fcitx im module because fcitx is only a third party application to Qt, but I also noticed some do bundle but not bundle all the required libraries. While fcitx 5 support ibus protocol, some of those applications do not even bundle ibus im module. There are a few different environment variables you can try for those proprietary Qt applications (WPS, Anki, DaVinci Resolve, Mathematica, etc...).

	<!--T:20-->		<!--T:20-->
Line 82:		Line 82:
	<!--T:23-->		<!--T:23-->
	So it will be able pick up the most usable one even for application that bundles no fcitx/wayland. Remember, you may still need to set( or unset) QT_IM_MODULE (not "QT_IM_MODULES") in order to handle Qt 4/5 applications.		So it will be able pick up the most usable one even for application that bundles no fcitx/wayland. Remember, you may still need to set( or unset) QT_IM_MODULE (not "QT_IM_MODULES") in order to handle Qt 4/5 applications.

			Qt 6.7 also brings text-input-v3 support, and there are some important fixes for text-input-v3 in the Qt 6.8 series ([https://bugreports.qt.io/issues/?jql=text%20input%20v3 related bugs]). If you are using a compositor that only supports text-input-v3, it should be OK to use text-input-v3 with Qt 6.8.2 or later.

	=== Legacy X11 application that runs under XWayland === <!--T:24-->		=== Legacy X11 application that runs under XWayland === <!--T:24-->
Line 97:		Line 99:

	=== Qt5 / Qt6 === <!--T:27-->		=== Qt5 / Qt6 === <!--T:27-->
			See [[#QT_IM_MODULE]].

	If your Qt application natively runs under Wayland, you can either unset QT_IM_MODULE to make it use text-input-v2, or set QT_IM_MODULE=fcitx to make it use fcitx im module.		If your Qt application natively runs under Wayland, you can either unset QT_IM_MODULE to make it use text-input-v2, or set QT_IM_MODULE=fcitx to make it use fcitx im module.

Line 190:		Line 194:
	** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application		** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application
	** Set <code>QT_IM_MODULE=fcitx</code> for Qt, since Qt5 would use XWayland by default.		** Set <code>QT_IM_MODULE=fcitx</code> for Qt, since Qt5 would use XWayland by default.
			** If you don't use Qt >=6.7,<6.8.2, set <code>QT_IM_MODULES="wayland;fcitx"</code> for Qt 6.8.2+
	** Run chrome with XWayland and <code>GTK_IM_MODULE=fcitx</code>		** Run chrome with XWayland and <code>GTK_IM_MODULE=fcitx</code>

Line 198:		Line 203:
	* Adding Fcitx 5 to autostart, it will replace any existing ibus-daemon upon start up so it will work out of box.		* Adding Fcitx 5 to autostart, it will replace any existing ibus-daemon upon start up so it will work out of box.
	* Popup candidate window is not able to be displayed over gnome-shell UI. Only solution is to use [[Special:MyLanguage/Kimpanel\|Kimpanel]], [https://extensions.gnome.org/extension/261/kimpanel/ link to extension].		* Popup candidate window is not able to be displayed over gnome-shell UI. Only solution is to use [[Special:MyLanguage/Kimpanel\|Kimpanel]], [https://extensions.gnome.org/extension/261/kimpanel/ link to extension].
	* Qt need to use QT_IM_MODULE=fcitx since ~~there is no~~ text-input-v2 ~~support~~.		* Qt < 6.8.2 need to use QT_IM_MODULE=fcitx since mutter doesn't support text-input-v2.

	=== Sway === <!--T:52-->		=== Sway === <!--T:52-->
Line 205:		Line 210:
	* Environment variables:		* Environment variables:
	** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application		** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application
	** Set <code>QT_IM_MODULE=fcitx</code> for Qt5, ~~and~~ set <code>QT_IM_MODULES="wayland;fcitx"</code> for Qt 6.7+		** Set <code>QT_IM_MODULE=fcitx</code> for Qt5
			** If you don't use Qt >=6.7,<6.8.2, set <code>QT_IM_MODULES="wayland;fcitx"</code> for Qt 6.8.2+

	Support Information:		Support Information:
Line 211:		Line 217:
	* Comopositor/Application uses zwp_input_method_v2. You will need sway 1.10+ (which includes [https://github.com/swaywm/sway/pull/7226 this pull request]) to make it show the popup candidate window for text-input-v3 client.		* Comopositor/Application uses zwp_input_method_v2. You will need sway 1.10+ (which includes [https://github.com/swaywm/sway/pull/7226 this pull request]) to make it show the popup candidate window for text-input-v3 client.
	* fcitx im module also works.		* fcitx im module also works.
	* Qt < 6.7 need to use QT_IM_MODULE=fcitx since ~~there is no~~ text-input-v2 ~~support~~.		* Qt < 6.8.2 need to use QT_IM_MODULE=fcitx since sway doesn't suppport text-input-v2.

	=== Weston === <!--T:53-->		=== Weston === <!--T:53-->

GalaxySnail: /* Sway */ update for sway 1.10+ and Qt 6.7+

2025-09-20T14:40:52Z

Sway: update for sway 1.10+ and Qt 6.7+

← Older revision		Revision as of 14:40, 20 September 2025
Line 201:		Line 201:

	=== Sway === <!--T:52-->		=== Sway === <!--T:52-->
			Best setup:
			* sway 1.10 or later
			* Environment variables:
			** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application
			** Set <code>QT_IM_MODULE=fcitx</code> for Qt5, and set <code>QT_IM_MODULES="wayland;fcitx"</code> for Qt 6.7+

			Support Information:
	* Application/Compositor uses text-input-v3		* Application/Compositor uses text-input-v3
	* Comopositor/Application uses zwp_input_method_v2~~, but it's partially implemented~~. You will need [https://github.com/swaywm/sway/pull/7226 this pull request] to make it show the popup candidate window for text-input-v3 client.		* Comopositor/Application uses zwp_input_method_v2. You will need sway 1.10+ (which includes [https://github.com/swaywm/sway/pull/7226 this pull request]) to make it show the popup candidate window for text-input-v3 client.
	* fcitx im module also works.		* fcitx im module also works.
	* Qt need to use QT_IM_MODULE=fcitx since there is no text-input-v2 support.		* Qt < 6.7 need to use QT_IM_MODULE=fcitx since there is no text-input-v2 support.

	=== Weston === <!--T:53-->		=== Weston === <!--T:53-->

Weng Xuetian at 05:48, 11 June 2025

2025-06-11T05:48:54Z

← Older revision		Revision as of 05:48, 11 June 2025
Line 167:		Line 167:
	=== KDE Plasma === <!--T:48-->		=== KDE Plasma === <!--T:48-->
	Best setup:		Best setup:
	* KDE Plasma 5.27		* KDE Plasma 5.27 or later
	* Environment variables:		* Environment variables:
	** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application		** Set <code>XMODIFIERS=@im=fcitx</code> for XWayland application

Remik1r3n: Marked this version for translation

2025-03-04T11:44:39Z

Marked this version for translation

Show changes

Remik1r3n at 11:44, 4 March 2025

2025-03-04T11:44:10Z

← Older revision		Revision as of 11:44, 4 March 2025
Line 1:		Line 1:
	<languages/>		<languages />
			<translate>
	[https://wayland.freedesktop.org/ Wayland] is the next generation of display server protocol. While the initial release of the protocol is in 2008, the support of input method is not really ideal.		[https://wayland.freedesktop.org/ Wayland] is the next generation of display server protocol. While the initial release of the protocol is in 2008, the support of input method is not really ideal.

Line 204:		Line 204:

	Now fcitx supports two protocol to figure out the focused window and the corresponding application name, including wlr-foreign-toplevel-management (used by wlroots based compositor) and plasma-window-management (used by kwin).		Now fcitx supports two protocol to figure out the focused window and the corresponding application name, including wlr-foreign-toplevel-management (used by wlroots based compositor) and plasma-window-management (used by kwin).
			</translate>

Remik1r3n at 11:43, 4 March 2025

2025-03-04T11:43:07Z

← Older revision		Revision as of 11:43, 4 March 2025
Line 1:		Line 1:
			<languages/>

	[https://wayland.freedesktop.org/ Wayland] is the next generation of display server protocol. While the initial release of the protocol is in 2008, the support of input method is not really ideal.		[https://wayland.freedesktop.org/ Wayland] is the next generation of display server protocol. While the initial release of the protocol is in 2008, the support of input method is not really ideal.

Weng Xuetian: /* Chromium / Electron */

2024-12-31T08:03:26Z

Chromium / Electron

← Older revision		Revision as of 08:03, 31 December 2024
Line 91:		Line 91:

	# If your compositor supports text-input-v1 protocol. Check the compositor section below.		# If your compositor supports text-input-v1 protocol. Check the compositor section below.
	chromium --enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime		chromium --enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime

			# If your compositor & chromium supports text-input-v3 protocol, you may also use
			chromium --enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime --wayland-text-input-version=3

			# However, due to a different understanding in text-input-v3 protocol, it has some issue when using with KWin.
			# Prefer text-input-v1 if you're using kwin.
			chromium --enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime --wayland-text-input-version=1

	Or		Or

Weng Xuetian at 05:08, 7 April 2024

2024-04-07T05:08:53Z

← Older revision		Revision as of 05:08, 7 April 2024
Line 37:		Line 37:
	It is possible to force a certain im module with Gtk configuration file, so without GTK_IM_MODULE set, it will still be able to use different im module.		It is possible to force a certain im module with Gtk configuration file, so without GTK_IM_MODULE set, it will still be able to use different im module.

	Per Gtk implementation (still valid for 3.24.41), ~~this line~~ is ~~ignored on wayland if text input is available~~ in ~~compositor. This makes it an ideal option for setting gtk im module to force fcitx im module for X11 while using text-input for~~ wayland.		Per Gtk implementation (still valid for 3.24.41), the order of preferences is:

			* X11
			** GTK_IM_MODULE in the environment
			** Value of Gtk/IMModule from XSettings
			** Value from configuration file
			** A locale based automatic selection
			* Wayland
			** GTK_IM_MODULE in the environment
			** "wayland"

	==== QT_IM_MODULE ====		==== QT_IM_MODULE ====

Weng Xuetian: /* GTK_IM_MODULE */

2024-04-07T05:03:57Z

GTK_IM_MODULE

← Older revision		Revision as of 05:03, 7 April 2024
Line 12:		Line 12:

	==== GTK_IM_MODULE ====		==== GTK_IM_MODULE ====
	~~For GTK_IM_MODULE~~, ~~as for now~~, ~~the modern~~ Gtk ~~3/4 application should be able to use~~ text-input-v3 ~~which is supported almost by every compositor, except weston~~. ~~There are a few different options in terms~~ of ~~setting the value of GTK_IM_MODULE. When it~~ is ~~unset, the Gtk built-in Wayland im module will be used for Gtk3 and Gtk4. While you can also enforce it by doing GTK_IM_MODULE=wayland, remember it will be also picked up by Gtk2~~. ~~Setting~~ GTK_IM_MODULE~~=fcitx can still work, and it is necessary if your compositor does not support Wayland input method frontend~~.		In an ideal setup, you should use fcitx im module Gtk application running under X11, and Gtk's text-input-v3 for wayland. The way of doing this is:

			1. Do NOT set GTK_IM_MODULE environment variable.

	~~It is possible to force a certain im module with Gtk configuration file, so without GTK_IM_MODULE set~~, ~~it will still be able~~ to ~~use different im module~~. ~~For Gtk~~ 2~~, you can write~~		2. For Gtk2, Add following content to ~/.gtkrc-2.0

	<nowiki>gtk-im-module="fcitx"</nowiki>		<nowiki>gtk-im-module="fcitx"</nowiki>
			3. For Gtk 3, add following content to ~/.config/gtk-3.0/settings.ini

			<nowiki>[Settings]
			gtk-im-module=fcitx</nowiki>

	~~in <code>~/.gtkrc-2.0</code>~~. For ~~Gtk3~~, ~~you can have gtk-im-module under "Settings" section in~~ ~/.config/gtk-3.0/settings.ini		4. For Gtk 4, add following content to ~/.config/gtk-4.0/settings.ini

	<nowiki>[Settings]		<nowiki>[Settings]
	gtk-im-module=fcitx</nowiki>		gtk-im-module=fcitx</nowiki>

			5. If you are using GNOME 3+, also run following command.

			<nowiki>gsettings set org.gnome.settings-daemon.plugins.xsettings overrides "{'Gtk/IMModule':<'fcitx'>}"</nowiki>

			For GTK_IM_MODULE, as for now, the modern Gtk 3/4 application should be able to use text-input-v3 which is supported almost by every compositor, except weston. There are a few different options in terms of setting the value of GTK_IM_MODULE. When it is unset, the Gtk built-in Wayland im module will be used for Gtk3 and Gtk4. While you can also enforce it by doing GTK_IM_MODULE=wayland, remember it will be also picked up by Gtk2. Setting GTK_IM_MODULE=fcitx can still work, and it is necessary if your compositor does not support Wayland input method frontend.

			It is possible to force a certain im module with Gtk configuration file, so without GTK_IM_MODULE set, it will still be able to use different im module.

	Per Gtk implementation (still valid for 3.24.41), this line is ignored on wayland if text input is available in compositor. This makes it an ideal option for setting gtk im module to force fcitx im module for X11 while using text-input for wayland.		Per Gtk implementation (still valid for 3.24.41), this line is ignored on wayland if text input is available in compositor. This makes it an ideal option for setting gtk im module to force fcitx im module for X11 while using text-input for wayland.