gradio_markdownlabel

Editable Markdown component with label functionality

MarkdownLabel Component Demo

Position vs Term Highlighting Comparison

This example shows the difference between position-based (yellow) and term-based (blue) highlighting.
{
  • "markdown_content": "# Comprehensive Markdown Example ## Introduction *The* quick **brown fox** jumps over the lazy dog. This is a simple quick example with various **formatting** elements. ### Lists and Items Here are some important points: 1. **First item** - This is the primary consideration 2. *Second item* - Another important point 3. Third item with `inline code` 4. Fourth item containing [a link](https://example.com) #### Unordered Lists - Bullet point one - Bullet point two with **bold text** - Final bullet point ### Code Block Example ```python def hello_world(): print("Hello, World!") return "success" ``` ### Tables | Column 1 | Column 2 | Column 3 | |----------|----------|----------| | Cell 1 | Cell 2 | Cell 3 | | Data A | Data B | Data C | ### Blockquotes > This is a blockquote with some **important** information. > > It can span multiple lines and contain *emphasis*. ### Mixed Content The document contains various **formatting** options including: - *Italicized text* for emphasis - **Bold text** for importance - `Inline code` for technical terms - Links like [this one](https://example.com) #### Final Section This concludes our comprehensive example with multiple markdown elements for testing position-based highlighting accuracy.",
  • "highlights": [
    • {
      • "term": "",
      • "position": [
        • 56,
        • 61
        ],
      • "title": "Quick",
      • "content": "Highlighted using exact character positions.",
      • "category": "Position Demo",
      • "color": "#ffeb3b"
      },
    • {
      • "term": "brown fox",
      • "position": [],
      • "title": "Brown Fox (Term Match)",
      • "content": "Highlighted using term matching - will match anywhere this term appears.",
      • "category": "Term Demo",
      • "color": "#e3f2fd"
      },
    • {
      • "term": "",
      • "position": [
        • 91,
        • 95
        ],
      • "title": "Lazy",
      • "content": "Position-based highlight",
      • "category": "Position Demo",
      • "color": "#ffeb3b"
      },
    • {
      • "term": "",
      • "position": [
        • 989,
        • 999
        ],
      • "title": "Italicized",
      • "content": "Highlighting 'Italicized'",
      • "category": "Position Demo",
      • "color": "#ff9800"
      },
    • {
      • "term": "formatting",
      • "position": [],
      • "title": "formatting (Term Match)",
      • "content": "Highlighted using term matching - will match anywhere this term appears.",
      • "category": "Term Demo",
      • "color": "#d0167f91"
      },
    • {
      • "term": "",
      • "position": [
        • 30,
        • 37
        ],
      • "title": "regression test",
      • "content": "Highlight across lines should not render",
      • "category": "Position Demo",
      • "color": "#ffeb3b"
      }
    ]
}

Installation

pip install gradio_markdownlabel

Usage


import gradio as gr
from gradio_markdownlabel import MarkdownLabel

with gr.Blocks(title="Markdown Label Demo") as demo:
    gr.Markdown("# MarkdownLabel Component Demo")
    
    # Simple position-based example
    example = {
        "markdown_content": """# Comprehensive Markdown Example

## Introduction
*The* quick **brown fox** jumps over the lazy dog. This is a simple quick example with various **formatting** elements.

### Lists and Items
Here are some important points:

1. **First item** - This is the primary consideration
2. *Second item* - Another important point  
3. Third item with `inline code`
4. Fourth item containing [a link](https://example.com)
""", 
        "highlights": [
            {
                "position": [56, 61],  # "quick" in "The quick brown fox", note the 2nd quick is not highlighted
                "title": "Quick",
                "content": "Highlighted using exact character positions.",
                "category": "Position Demo",
                "color": "#ffeb3b"
            },
            {
                "term": "brown fox",
                "title": "Brown Fox (Term Match)",
                "content": "Highlighted using term matching - will match anywhere this term appears.",
                "category": "Term Demo", 
                "color": "#e3f2fd"
            },
            {
                "position": [91, 95],  # "lazy" in "the lazy dog"
                "title": "Lazy", 
                "content": "Position-based highlight",
                "category": "Position Demo",
                "color": "#ffeb3b"
            }
        ]
    }
    
    gr.Markdown("## Position vs Term Highlighting Comparison")
    gr.Markdown("This example shows the difference between position-based (yellow) and term-based (blue) highlighting.")
    MarkdownLabel(
        value=example,
        label="Simple Position vs Term Example",
        show_side_panel=True,
        panel_width="300px",
        interactive=True
    )

if __name__ == "__main__":
    demo.launch()

MarkdownLabel

Initialization
Parameters 
value: dict | Callable | None
default = None

Dictionary containing markdown_content and highlights array. If a function is provided, the function will be called each time the app loads to set the initial value of this component.

show_side_panel: bool
default = True

Whether to show the detailed information side panel.

panel_width: str
default = "300px"

Width of the side panel (CSS value like "300px", "25%", etc.).

edit_mode: str
default = "split"

Layout for editing mode - "split" (side-by-side), "tabs", or "overlay".

show_preview: bool
default = True

Whether to show live preview in edit mode.

markdown_editor: str
default = "textarea"

Type of markdown editor - "textarea" or "codemirror" (future).

label: str | I18nData | None
default = None

the label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.

every: Timer | float | None
default = None

Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.

inputs: Component | Sequence[Component] | set[Component] | None
default = None

Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.

show_label: bool | None
default = None

if True, will display label.

container: bool
default = True

If True, will place the component in a container - providing some extra padding around the border.

scale: int | None
default = None

relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.

min_width: int
default = 160

minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.

visible: bool
default = True

If False, component will be hidden.

elem_id: str | None
default = None

An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.

elem_classes: list[str] | str | None
default = None

An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.

render: bool
default = True

If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.

key: int | str | tuple[int | str, ...] | None
default = None

in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render.

preserved_by_key: list[str] | str | None
default = "value"

A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor.

interactive: bool | None
default = None

If True, the component will be editable allowing users to modify markdown content.

rtl: bool
default = False

If True, will display the text in right-to-left direction.

Events
Parameters 
change

Triggered when the value of the MarkdownLabel changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input.

select

Event listener for when the user selects or deselects the MarkdownLabel. Uses event data gradio.SelectData to carry `value` referring to the label of the MarkdownLabel, and `selected` to refer to state of the MarkdownLabel. See EventData documentation on how to use this event data

edit

This listener is triggered when the user edits the MarkdownLabel (e.g. image) using the built-in editor.

submit

This listener is triggered when the user presses the Enter key while the MarkdownLabel is focused.

clear

This listener is triggered when the user clears the MarkdownLabel using the clear button for the component.

User function

The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

  • When used as an Input, the component only impacts the input signature of the user function.
  • When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

  • As input: Is passed, passes the value as a dictionary with markdown_content and highlights.
  • As output: Should return, expects a dictionary with 'markdown_content' and 'highlights' keys.
def predict(
   value: dict | None
) -> dict | None:
   return value