JSXElement

Abstract representation of TSX/JSX elements, e.g. `<MyComponent />`. This allows for many React-specific modifications, like adding props, changing the name, etc.

View source on GitHub

Inherits from

Expression, HasName, Editable

Attributes

attributes

Returns all JSXProp on this JSXElement, an alias for JSXElement.props.

expressions

Gets all JSX expressions within the JSX element.

extended

Returns a SymbolGroup of all extended nodes associated with this element.

extended_source

Returns the source text representation of all extended nodes.

file

The file object that this Editable instance belongs to.

filepath

The file path of the file that this Editable instance belongs to.

full_name

Returns the full name of the object, including the namespace path.

function_calls

Returns a list of all function calls contained within this expression.

jsx_elements

Returns a list of JSX elements nested within the current element.

name

Retrieves the base name of the object without namespace prefixes.

parent

The parent node of this Editable instance.

parent_class

Find the class this node is contained in

parent_function

Find the function this node is contained in

parent_statement

Find the statement this node is contained in

props

Retrieves all JSXProps (attributes) from a JSX element.

resolved_value

Returns the resolved type of an Expression.

source

Text representation of the Editable instance.

variable_usages

Returns Editables for all TreeSitter node instances of variable usages within this node's

Methods

add_prop

Adds a new prop to a JSXElement.

View source on GitHub

Parameters

prop_namerequired

The name of the prop to add.

prop_valuerequired

The value of the prop to add.

Returns

ancestors

Find all ancestors of the node of the given type. Does not return itself

View source on GitHub

Returns

edit

Replace the source of this Editable with new_src.

View source on GitHub

Parameters

new_srcrequired

The new source text to replace the current text with.

fix_indentationdefault: False

If True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.

prioritydefault: 0

The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.

dedupedefault: True

If True, deduplicates identical transactions. Defaults to True.

Returns

find

Find and return matching nodes or substrings within an Editable instance.

View source on GitHub

Parameters

strings_to_matchrequired

One or more strings to search for.

exactdefault: False

If True, only return nodes whose source exactly matches one of the strings_to_match.

Returns

A list of Editable instances that match the search criteria.

find_string_literals

Returns a list of string literals within this node's source that match any of the given

View source on GitHub

Parameters

strings_to_matchrequired

A list of strings to search for in string literals.

fuzzy_matchdefault: False

If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.

Returns

A list of Editable objects representing the matching string literals.

flag

Adds a visual flag comment to the end of this Editable's source text.

View source on GitHub

Returns

get_name

Returns the name node of the object.

View source on GitHub

Returns

The name node of the object. Can be a Name node for simple names, a ChainedAttribute for names with namespaces (e.g., a.b), or None if the object has no name.

get_prop

Returns the JSXProp with the given name from the JSXElement.

View source on GitHub

Parameters

namerequired

The name of the prop to find.

Returns

The matching JSXProp object if found, None if not found.

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

View source on GitHub

Parameters

var_namerequired

The variable name to search for.

fuzzy_matchdefault: False

If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.

Returns

List of Editable objects representing variable usage nodes matching the given name.

insert_after

Inserts code after this node.

View source on GitHub

Parameters

new_srcrequired

The source code to insert after this node.

fix_indentationdefault: False

Whether to adjust the indentation of new_src to match the current node. Defaults to False.

newlinedefault: True

Whether to add a newline before the new_src. Defaults to True.

prioritydefault: 0

Priority of the insertion transaction. Defaults to 0.

dedupedefault: True

Whether to deduplicate identical transactions. Defaults to True.

Returns

insert_before

Inserts text before this node's source with optional indentation and newline handling.

View source on GitHub

Parameters

new_srcrequired

The text to insert before this node.

fix_indentationdefault: False

Whether to fix the indentation of new_src to match the current node. Defaults to False.

newlinedefault: True

Whether to add a newline after new_src. Defaults to True.

prioritydefault: 0

Transaction priority for managing multiple edits. Defaults to 0.

Whether to delete surrounding whitespace and formatting. Defaults to True.

prioritydefault: 0

Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.

dedupedefault: True

Whether to deduplicate removal transactions at the same location. Defaults to True.

Returns

rename

Sets the name of an object and updates all its usages.

View source on GitHub

Parameters

namerequired

The new name to assign to the object.

Returns

replace

Search and replace occurrences of text within this node's source and its extended nodes.

View source on GitHub

Parameters

oldrequired

The text or pattern to search for.

newrequired

The text to replace matches with.

countdefault: -1

Maximum number of replacements to make. Defaults to -1 (replace all).

is_regexdefault: False

Whether to treat 'old' as a regex pattern. Defaults to False.

prioritydefault: 0

Priority of the replacement operation. Defaults to 0.

Returns

The total number of replacements made.

search

Returns a list of all regex match of regex_pattern, similar to python's re.search().

View source on GitHub

Parameters

regex_patternrequired

The regular expression pattern to search for.

include_stringsdefault: True

When False, excludes the contents of string literals from the search. Defaults to True.

include_commentsdefault: True

When False, excludes the contents of comments from the search. Defaults to True.

Returns

A list of Editable objects corresponding to the matches found.

set_name

Sets the name of a JSXElement by modifying both opening and closing tags.

View source on GitHub

Parameters

namerequired

The new name to set for the JSX element.

Returns

The method modifies the JSXElement in place.

wrap

Wraps the current JSXElement with the provided opening and closing tags, properly handling indentation.

View source on GitHub

Parameters

opening_tagrequired

The opening JSX tag to wrap around the current element (e.g. `<div prop={value}>`)

closing_tagrequired

The closing JSX tag to wrap around the current element (e.g. `</div>`)