| Name | reflex-monaco-editor JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Reflex Monaco Editor component with LSP capability |
| upload_time | 2025-10-30 21:14:14 |
| maintainer | None |
| docs_url | None |
| author | riebecj |
| requires_python | >=3.10 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
reflex
reflex-custom-components
monaco
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# reflex-monaco-editor
## Overview
`reflex-monaco-editor` provides integration of the Monaco Editor with support for Terraform syntax highlighting and language features via `terraform-ls`. This project enables embedding a powerful code editor in Python web applications, with extensible language support.
> NOTE: This has not been fully tested in a compiled Reflex app for production. If there are any bugs or issues, please report them.
---
## Table of Contents
- [Getting Started](#getting-started)
- [Demo](#demo)
- [Built-In Language Clients](#available-built-in-language-clients)
- [API Documentation](#api-documentation)
- [Contributing](#how-to-contribute)
---
## Getting Started
### 1. Installation
Install the package
```bash
pip install reflex-monaco-editor
```
### 2. Apply Config
If you're not using any other custom Vite config, you can do this in your `rxconfig.py`:
```python
import reflex as rx
from vite_config_plugin import ViteConfigPlugin
from monaco_editors.config import MonacoEditorsReflexConfig
config = rx.Config(
...
plugins=[
...
ViteConfigPlugin(
MonacoEditorsReflexConfig.get_vite_config(),
imports=MonacoEditorsReflexConfig.get_imports(),
dependencies=MonacoEditorsReflexConfig.get_dependencies(),
)
]
)
```
If you need other custom configurations, do this instead:
```python
import reflex as rx
from vite_config_plugin import ViteConfigPlugin
from monaco_editors.config import MonacoEditorsReflexConfig
config = rx.Config(
...
plugins=[
...
ViteConfigPlugin(
..., # your custom vite config for your project
imports=[
..., # your other custom imports
*MonacoEditorsReflexConfig.get_imports(),
],
dependencies=[
..., # your other frontend dependencies
*MonacoEditorsReflexConfig.get_dependencies()
],
extra_configs=[
..., # Any other Vite configs you're merging in your project config
MonacoEditorsReflexConfig.get_vite_config()
]
)
]
)
```
The imports, dependencies, and config ensure that Vite handles the necessary libraries correctly.
### 3. Creating a Basic Editor
The minimum required keywork argument is `filename`.
```python
import reflex as rx
from reflex_monaco_editor import monaco_editor
@rx.page("/")
def home() -> rx.Component:
return rx.flex(
monaco_editor(filename="demo.txt")
)
```
> For advanced configuration, see the [API documentation](#api-documentation).
---
## Demo
To run the demo, just clone the repository and either do:
```
pants lock
pants run demo
```
If you have `pants` installed, or:
```
pip install .
reflex run
```
---
## Available Built-In Language Clients
### Terraform
To provide Terraform/HCL language client integration, a VSIX file is included as a shared `rx.asset()` to the editor component and imported by it, and the
`@codingame/monaco-vscode-rollup-vsix-plugin` vite plugin handles the asset loading. This provides the editor with syntax highlighting and other VSCode
editor features, but it does not work with web workers (blame HashiCorp). To get around this, there's a Reflex app lifespan task called `start_terraform_ls`
that you can import and pass to your app on start-up. This will download [lsp-ws-proxy](https://github.com/qualified/lsp-ws-proxy) and
[terraform-ls](https://github.com/hashicorp/terraform-ls) binaries from GitHub to your `.web/backend/bin` directory.
#### Lifespan Task
It's not ***required** to use this lifespan task. You can download them yourself, but you will need to ensure they're listening on your specified port
before starting the editor or the language client won't connect.
To use the lifespan task just import and register like this:
```python
from monaco_editors import start_terraform_ls
app = rx.App()
app.register_lifespan_task(start_terraform_ls)
```
#### Editor + Language Client Config
Assuming your `terraform-ls` server is listening on port 9999 on the localhost, here's how you'd need to configure the editor at a minimum:
```python
from monaco_editors import monaco_editor
def editor():
return monaco_editor(
filename="main.tf", # needs to be a standard Terraform/HCL file type.
language_clients=[
monaco_editor.language_client(
language_id="terraform", # Must be 'terraform'
url=monaco_editor.server_url(host="localhost", port=9999, secured=False), # configure as needed. The default for `secured` is `True`.
),
],
)
```
> See API Documentation for more information on available configurations.
---
# API Documentation
## Monaco Editor
The `monaco_editor` has the available configuration:
```python
class MonacoEditorReactComp(rx.Component):
...
###### Required Attributes ######
# The name of the 'file' to open in the editor.
filename: str | rx.Var[str]
###### Optional Attributes ######
# Theme configured based on Reflex color mode condition.
theme = rx.color_mode_cond(dark="Default Dark Modern", light="Default Light Modern")
# The editor code content of the 'file'
value: str | rx.Var[str] = ""
# The name of the worspace/folder/directory of the 'file'.
workspace_folder: str | rx.Var[str] | None = None
# Any configured language clients for the editor.
language_clients: list[LanguageClientConfig] = [] # noqa: RUF012
# The monaco editor log level (logs to browser console).
loglevel: Literal["Off", "Trace", "Debug", "Info", "Warning", "Error"] = "Info"
# The HTML class of the editor window.
class_name: str = "w-full h-full"
###### Configurable Event Handlers ######
# Fires on editor code content change. Returns the contant as a TextModel object.
on_change: rx.EventHandler[rx.event.passthrough_event_spec(TextModel)]
# Fires when an user-registered editor command executes. Returns the name of the registered command.
on_command: rx.EventHandler[rx.event.passthrough_event_spec(str)]
# Fires when a language client is restarted. Returns the name of the editor langauge client that restarts.
on_restart: rx.EventHandler[rx.event.passthrough_event_spec(str)]
# Fires when an user-registered editor command finishes. Returns the name of the registered command.
on_command_complete: rx.EventHandler[rx.event.passthrough_event_spec(str)]
```
## Language Client Configs
The `LanguageClientConfig` is a Pydantic model that provides a configured language client to the monaco editor.
```python
class LanguageClientConfig(BaseModel):
"""The Monaco Language Client Config.
Params:
language_id (str): The language ID registered with the editor.
url (LanguageServerUrl): The langauge server URL object.
register_commands (dict[str, Command]): The mapping of command names and configs to register wuth the editor.
document_selector (list[str | dict[str, str]] | None): The optional document selector for the LSP.
initialization_options (dict): The language-specific LSP opts to provide the language server upon connection.
"""
language_id: str
url: LanguageServerUrl
register_commands: Annotated[str, PlainValidator(_var_validator), Field(default="")]
document_selector: Annotated[list[str | dict[str, str]] | None, Field(default=None)]
initialization_options: Annotated[str, PlainValidator(_var_validator), Field(default="")]
```
While the `register_commands` and `initialization_options` say the type should be a `str`, it actually accepts an `rx.Var[dict[str, Command]]` and raises a `TypeError`
if the value isn't a Reflex var. This is by design.
> See more about [`register_commands`](#registered-editor-command). The `initialization_options` are LSP or Language Server specific.
## Registered Editor Command
The `Command` Pydantic model helps to register a command between the Monaco editor and the language server, allowing the editor to perform actions
and tasks avaiable to your language server.
```python
class Command(BaseModel):
"""Language Servers Commands.
Used to register Monaco editor commands with the language client.
Params:
type (Literal["notification", "request"]): The type of LSP command to execute.
method (str): The LSP method to send (based on the specific language server).
params (dict[str, Any]): The parameters to send.
restart_client: (bool): If the editor's language client should be restarted after command completion.
"""
type: Literal["notification", "request"]
method: str
params: dict[str, Any]
restart_client: Annotated[bool, Field(default=False)]
```
### Example:
How this is configured will be dependant on your LSP's documentation. I'll use [`terraform.init`](https://github.com/hashicorp/terraform-ls/blob/main/docs/commands.md#terraforminit)
as an example.
More often than not, the `type` of request commands use are **request**. This is true for `terraform-ls`. The `method` is the LSP method, in this case it's `workspace/executeCommand`. Based on the [documentation](https://github.com/hashicorp/terraform-ls/blob/main/docs/commands.md#arguments) for `terraform-ls`, we know the `params` it expects is:
```
{
"command": "command-name",
"arguments": [ "key=value" ]
}
```
And `terraform.init` expects an argument of `uri` set to the directory in which to run `init`; making it `[ "uri=file:///path/to/my/dir" ]`. And if a restart of the client is
necessary or benficial, you can set `restart_client` to `True`. This would be the entire `Command` config you'd add to your dict of commands looks like this:
```python
"terraform.init": Command(
type="request",
method="workspace/executeCommand",
params={
"command": "terraform-ls.terraform.init",
"arguments": ["uri=file:///path/to/my/dir"]
},
restart_client=True
)
```
## Language Server URL
The only currently available method for connecting to a language server is via websocket URL. The `LanguageServerUrl` model
helps specify and format the URL correctly.
```python
class LanguageServerUrl(BaseModel):
"""The language server URL.
Params:
host (str): The hostname with a language server websocket.
port (int): The host's websocket port number.
secured (bool): Whether the connection is secure (use `wss` instead of `ws`)
path (str): Additional path URI for the langauge server.
"""
host: str
port: int
secured: Annotated[bool, Field(default=True)]
path: Annotated[str, Field(default="")]
```
## Namespace
To make it easier (and less imports), all of the major moving parts are grouped into an `rx.ComponentNamespace` for convenient configuration and importing.
```python
class Monaco(rx.ComponentNamespace):
"""Namespace for Monaco editor components and configuration."""
__call__ = MonacoEditorReactComp.create
language_client = LanguageClientConfig
server_url = LanguageServerUrl
command = Command
monaco_editor = Monaco()
```
So, in your code, all you need to do is:
```python
from monaco_editors import monaco_editor
def my_editor():
return monaco_editor(
filename="foo.txt",
language_clients=[
monaco_editor.language_client(
language_id="my-lang",
url=monaco_editor.server_url(...),
register_commands={
"my-lsp.command": monaco_editor.command(...),
... # other commands
},
... # other options
)
],
... # other settings or event handlers
)
```
## How to Contribute
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
### Prereuisites
This repository builds with [pantsbuild](https://www.pantsbuild.org/) which requires Linux or Mac. If you're on a Windows, you can use WSL.
Install `pants` using the [provided instructions](https://www.pantsbuild.org/stable/docs/getting-started/installing-pants) for your OS.
### Development Setup
1. Fork the repository and clone.
2. Install dependencies: `pants lock`
3. *Optionally* export a venv: `pants venv`. Creates `dist/export/python/virtualenvs/python-default/3.X.Y`.
4. If you run `pants venv` you can update your IDE interpreter using the available venv.
Now you can make code changes as necessary.
### Submitting a PR
Before you submit a PR, ensure the following run without errors:
1. Run tests: `pants test all`
2. Format code: `pants fmt all`
3. Lint code: `pants lint all`
---
## License
See [LICENSE](LICENSE) for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-monaco-editor",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "reflex, reflex-custom-components, monaco",
"author": "riebecj",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/70/3d/6f73d8ba9a60ba36cc3c2c176d9036cfac2e15da78dbceeb6cb7297e96ff/reflex_monaco_editor-1.0.0.tar.gz",
"platform": null,
"description": "# reflex-monaco-editor\n\n## Overview\n\n`reflex-monaco-editor` provides integration of the Monaco Editor with support for Terraform syntax highlighting and language features via `terraform-ls`. This project enables embedding a powerful code editor in Python web applications, with extensible language support.\n\n> NOTE: This has not been fully tested in a compiled Reflex app for production. If there are any bugs or issues, please report them.\n\n---\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n - [Demo](#demo)\n- [Built-In Language Clients](#available-built-in-language-clients)\n- [API Documentation](#api-documentation)\n- [Contributing](#how-to-contribute)\n\n---\n\n## Getting Started\n\n### 1. Installation\n\nInstall the package\n\n```bash\npip install reflex-monaco-editor\n```\n\n### 2. Apply Config\n\nIf you're not using any other custom Vite config, you can do this in your `rxconfig.py`:\n\n```python\nimport reflex as rx\nfrom vite_config_plugin import ViteConfigPlugin\nfrom monaco_editors.config import MonacoEditorsReflexConfig\n\nconfig = rx.Config(\n ...\n plugins=[\n ...\n ViteConfigPlugin(\n MonacoEditorsReflexConfig.get_vite_config(),\n imports=MonacoEditorsReflexConfig.get_imports(),\n dependencies=MonacoEditorsReflexConfig.get_dependencies(),\n )\n ]\n)\n```\n\nIf you need other custom configurations, do this instead:\n\n```python\nimport reflex as rx\nfrom vite_config_plugin import ViteConfigPlugin\nfrom monaco_editors.config import MonacoEditorsReflexConfig\n\nconfig = rx.Config(\n ...\n plugins=[\n ...\n ViteConfigPlugin(\n ..., # your custom vite config for your project\n imports=[\n ..., # your other custom imports\n *MonacoEditorsReflexConfig.get_imports(),\n ],\n dependencies=[\n ..., # your other frontend dependencies\n *MonacoEditorsReflexConfig.get_dependencies()\n ],\n extra_configs=[\n ..., # Any other Vite configs you're merging in your project config\n MonacoEditorsReflexConfig.get_vite_config()\n ]\n )\n ]\n)\n```\n\nThe imports, dependencies, and config ensure that Vite handles the necessary libraries correctly.\n\n### 3. Creating a Basic Editor\n\nThe minimum required keywork argument is `filename`.\n\n```python\nimport reflex as rx\nfrom reflex_monaco_editor import monaco_editor\n\n@rx.page(\"/\")\ndef home() -> rx.Component:\n return rx.flex(\n monaco_editor(filename=\"demo.txt\")\n )\n```\n\n> For advanced configuration, see the [API documentation](#api-documentation).\n\n---\n\n## Demo\n\nTo run the demo, just clone the repository and either do:\n\n```\npants lock\npants run demo\n```\n\nIf you have `pants` installed, or:\n\n```\npip install .\nreflex run\n```\n\n---\n\n## Available Built-In Language Clients\n\n### Terraform\n\nTo provide Terraform/HCL language client integration, a VSIX file is included as a shared `rx.asset()` to the editor component and imported by it, and the\n`@codingame/monaco-vscode-rollup-vsix-plugin` vite plugin handles the asset loading. This provides the editor with syntax highlighting and other VSCode\neditor features, but it does not work with web workers (blame HashiCorp). To get around this, there's a Reflex app lifespan task called `start_terraform_ls`\nthat you can import and pass to your app on start-up. This will download [lsp-ws-proxy](https://github.com/qualified/lsp-ws-proxy) and\n[terraform-ls](https://github.com/hashicorp/terraform-ls) binaries from GitHub to your `.web/backend/bin` directory.\n\n#### Lifespan Task\n\nIt's not ***required** to use this lifespan task. You can download them yourself, but you will need to ensure they're listening on your specified port\nbefore starting the editor or the language client won't connect.\n\nTo use the lifespan task just import and register like this:\n\n```python\nfrom monaco_editors import start_terraform_ls\n\napp = rx.App()\napp.register_lifespan_task(start_terraform_ls)\n```\n\n#### Editor + Language Client Config\n\nAssuming your `terraform-ls` server is listening on port 9999 on the localhost, here's how you'd need to configure the editor at a minimum:\n\n```python\nfrom monaco_editors import monaco_editor\n\ndef editor():\n return monaco_editor(\n filename=\"main.tf\", # needs to be a standard Terraform/HCL file type.\n language_clients=[\n monaco_editor.language_client(\n language_id=\"terraform\", # Must be 'terraform'\n url=monaco_editor.server_url(host=\"localhost\", port=9999, secured=False), # configure as needed. The default for `secured` is `True`.\n ),\n ],\n )\n```\n\n> See API Documentation for more information on available configurations.\n\n---\n\n# API Documentation\n\n## Monaco Editor\n\nThe `monaco_editor` has the available configuration:\n\n```python\nclass MonacoEditorReactComp(rx.Component):\n ...\n ###### Required Attributes ######\n # The name of the 'file' to open in the editor.\n filename: str | rx.Var[str]\n\n ###### Optional Attributes ######\n # Theme configured based on Reflex color mode condition.\n theme = rx.color_mode_cond(dark=\"Default Dark Modern\", light=\"Default Light Modern\")\n # The editor code content of the 'file'\n value: str | rx.Var[str] = \"\"\n # The name of the worspace/folder/directory of the 'file'.\n workspace_folder: str | rx.Var[str] | None = None\n # Any configured language clients for the editor.\n language_clients: list[LanguageClientConfig] = [] # noqa: RUF012\n # The monaco editor log level (logs to browser console).\n loglevel: Literal[\"Off\", \"Trace\", \"Debug\", \"Info\", \"Warning\", \"Error\"] = \"Info\"\n # The HTML class of the editor window.\n class_name: str = \"w-full h-full\"\n\n ###### Configurable Event Handlers ######\n # Fires on editor code content change. Returns the contant as a TextModel object.\n on_change: rx.EventHandler[rx.event.passthrough_event_spec(TextModel)]\n # Fires when an user-registered editor command executes. Returns the name of the registered command.\n on_command: rx.EventHandler[rx.event.passthrough_event_spec(str)]\n # Fires when a language client is restarted. Returns the name of the editor langauge client that restarts.\n on_restart: rx.EventHandler[rx.event.passthrough_event_spec(str)]\n # Fires when an user-registered editor command finishes. Returns the name of the registered command.\n on_command_complete: rx.EventHandler[rx.event.passthrough_event_spec(str)]\n```\n\n\n## Language Client Configs\n\nThe `LanguageClientConfig` is a Pydantic model that provides a configured language client to the monaco editor.\n\n```python\nclass LanguageClientConfig(BaseModel):\n \"\"\"The Monaco Language Client Config.\n\n Params:\n language_id (str): The language ID registered with the editor.\n url (LanguageServerUrl): The langauge server URL object.\n register_commands (dict[str, Command]): The mapping of command names and configs to register wuth the editor.\n document_selector (list[str | dict[str, str]] | None): The optional document selector for the LSP.\n initialization_options (dict): The language-specific LSP opts to provide the language server upon connection.\n \"\"\"\n language_id: str\n url: LanguageServerUrl\n register_commands: Annotated[str, PlainValidator(_var_validator), Field(default=\"\")]\n document_selector: Annotated[list[str | dict[str, str]] | None, Field(default=None)]\n initialization_options: Annotated[str, PlainValidator(_var_validator), Field(default=\"\")]\n```\n\nWhile the `register_commands` and `initialization_options` say the type should be a `str`, it actually accepts an `rx.Var[dict[str, Command]]` and raises a `TypeError`\nif the value isn't a Reflex var. This is by design.\n\n> See more about [`register_commands`](#registered-editor-command). The `initialization_options` are LSP or Language Server specific.\n\n## Registered Editor Command\n\nThe `Command` Pydantic model helps to register a command between the Monaco editor and the language server, allowing the editor to perform actions\nand tasks avaiable to your language server. \n\n```python\nclass Command(BaseModel):\n \"\"\"Language Servers Commands.\n\n Used to register Monaco editor commands with the language client.\n\n Params:\n type (Literal[\"notification\", \"request\"]): The type of LSP command to execute.\n method (str): The LSP method to send (based on the specific language server).\n params (dict[str, Any]): The parameters to send.\n restart_client: (bool): If the editor's language client should be restarted after command completion.\n \"\"\"\n type: Literal[\"notification\", \"request\"]\n method: str\n params: dict[str, Any]\n restart_client: Annotated[bool, Field(default=False)]\n```\n\n### Example:\n\nHow this is configured will be dependant on your LSP's documentation. I'll use [`terraform.init`](https://github.com/hashicorp/terraform-ls/blob/main/docs/commands.md#terraforminit)\nas an example. \n\nMore often than not, the `type` of request commands use are **request**. This is true for `terraform-ls`. The `method` is the LSP method, in this case it's `workspace/executeCommand`. Based on the [documentation](https://github.com/hashicorp/terraform-ls/blob/main/docs/commands.md#arguments) for `terraform-ls`, we know the `params` it expects is:\n\n```\n{\n\t\"command\": \"command-name\",\n\t\"arguments\": [ \"key=value\" ]\n}\n```\n\nAnd `terraform.init` expects an argument of `uri` set to the directory in which to run `init`; making it `[ \"uri=file:///path/to/my/dir\" ]`. And if a restart of the client is\nnecessary or benficial, you can set `restart_client` to `True`. This would be the entire `Command` config you'd add to your dict of commands looks like this:\n\n```python\n\"terraform.init\": Command(\n type=\"request\",\n method=\"workspace/executeCommand\",\n params={\n \"command\": \"terraform-ls.terraform.init\",\n \"arguments\": [\"uri=file:///path/to/my/dir\"]\n },\n restart_client=True\n)\n```\n\n## Language Server URL\n\nThe only currently available method for connecting to a language server is via websocket URL. The `LanguageServerUrl` model\nhelps specify and format the URL correctly.\n\n```python\nclass LanguageServerUrl(BaseModel):\n \"\"\"The language server URL.\n\n Params:\n host (str): The hostname with a language server websocket.\n port (int): The host's websocket port number.\n secured (bool): Whether the connection is secure (use `wss` instead of `ws`)\n path (str): Additional path URI for the langauge server.\n \"\"\"\n host: str\n port: int\n secured: Annotated[bool, Field(default=True)]\n path: Annotated[str, Field(default=\"\")]\n```\n\n## Namespace\n\nTo make it easier (and less imports), all of the major moving parts are grouped into an `rx.ComponentNamespace` for convenient configuration and importing.\n\n```python\nclass Monaco(rx.ComponentNamespace):\n \"\"\"Namespace for Monaco editor components and configuration.\"\"\"\n\n __call__ = MonacoEditorReactComp.create\n language_client = LanguageClientConfig\n server_url = LanguageServerUrl\n command = Command\n\n\nmonaco_editor = Monaco()\n```\n\nSo, in your code, all you need to do is:\n\n```python\nfrom monaco_editors import monaco_editor\n\ndef my_editor():\n return monaco_editor(\n filename=\"foo.txt\",\n language_clients=[\n monaco_editor.language_client(\n language_id=\"my-lang\",\n url=monaco_editor.server_url(...),\n register_commands={\n \"my-lsp.command\": monaco_editor.command(...),\n ... # other commands\n },\n ... # other options\n )\n ],\n ... # other settings or event handlers\n )\n```\n\n## How to Contribute\n\nContributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.\n\n### Prereuisites\n\nThis repository builds with [pantsbuild](https://www.pantsbuild.org/) which requires Linux or Mac. If you're on a Windows, you can use WSL.\nInstall `pants` using the [provided instructions](https://www.pantsbuild.org/stable/docs/getting-started/installing-pants) for your OS.\n\n### Development Setup\n\n1. Fork the repository and clone.\n2. Install dependencies: `pants lock`\n3. *Optionally* export a venv: `pants venv`. Creates `dist/export/python/virtualenvs/python-default/3.X.Y`.\n4. If you run `pants venv` you can update your IDE interpreter using the available venv.\n\nNow you can make code changes as necessary.\n\n### Submitting a PR\n\nBefore you submit a PR, ensure the following run without errors:\n\n1. Run tests: `pants test all`\n2. Format code: `pants fmt all`\n3. Lint code: `pants lint all`\n\n---\n\n## License\n\nSee [LICENSE](LICENSE) for details.\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "Reflex Monaco Editor component with LSP capability",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/riebecj/reflex-monaco-editor?tab=readme-ov-file#reflex-monaco-editor",
"Issues": "https://github.com/riebecj/reflex-monaco-editor/issues",
"Repository": "https://github.com/riebecj/reflex-monaco-editor"
},
"split_keywords": [
"reflex",
" reflex-custom-components",
" monaco"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8934929a056ecf853474e2947ddc78d057b2c3f556e5af8fc1aa101ed520a627",
"md5": "9c3f77dc0823a027c931ee56c7e1de35",
"sha256": "807212515f990661f0eb1d0763627af236334669e888981d25dda43d7add8294"
},
"downloads": -1,
"filename": "reflex_monaco_editor-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c3f77dc0823a027c931ee56c7e1de35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 576607,
"upload_time": "2025-10-30T21:14:12",
"upload_time_iso_8601": "2025-10-30T21:14:12.725812Z",
"url": "https://files.pythonhosted.org/packages/89/34/929a056ecf853474e2947ddc78d057b2c3f556e5af8fc1aa101ed520a627/reflex_monaco_editor-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "703d6f73d8ba9a60ba36cc3c2c176d9036cfac2e15da78dbceeb6cb7297e96ff",
"md5": "b50baf8aa74a180ba11a7d77b6e0cb95",
"sha256": "02d0068894c487302c72fcd578d7bce398a3904935c9b8612a1043edc8186d18"
},
"downloads": -1,
"filename": "reflex_monaco_editor-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b50baf8aa74a180ba11a7d77b6e0cb95",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 582737,
"upload_time": "2025-10-30T21:14:14",
"upload_time_iso_8601": "2025-10-30T21:14:14.471085Z",
"url": "https://files.pythonhosted.org/packages/70/3d/6f73d8ba9a60ba36cc3c2c176d9036cfac2e15da78dbceeb6cb7297e96ff/reflex_monaco_editor-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-30 21:14:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "riebecj",
"github_project": "reflex-monaco-editor?tab=readme-ov-file#reflex-monaco-editor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "reflex-monaco-editor"
}
