Skip to main content

Find React prop usage

org.openrewrite.react.search.FindPropUsage

Locates usages of a specific prop of a React component.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringcomponentNameThe name of the React component to analyzeButton
StringpropNameOptional. The name of the prop to find. If not provided, all props are matched.onClick

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindPropUsageExample
displayName: Find React prop usage example
recipeList:
  - org.openrewrite.react.search.FindPropUsage: 
      componentName: Button
      propName: onClick

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FindPropUsage --recipe-option "componentName=Button" --recipe-option "propName=onClick"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-react:0.1.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

React component prop usages​

org.openrewrite.react.table.PropUsages

Information about how specific component props are used.

Column NameDescription
Component nameThe name of the React component that receives this prop.
File pathThe source file path where this prop usage occurs.
Prop nameThe name of the prop being used.