diff --git a/docs/rules/jsx-no-target-blank.md b/docs/rules/jsx-no-target-blank.md index be20205c2a..dd0cdb4c9b 100644 --- a/docs/rules/jsx-no-target-blank.md +++ b/docs/rules/jsx-no-target-blank.md @@ -12,14 +12,17 @@ This rule aims to prevent user generated links from creating security vulnerabil `rel='noreferrer noopener'` for external links, and optionally any dynamically generated links. ## Rule Options +```json +... +"react/jsx-no-target-blank": [, { "enforceDynamicLinks": }] +... +``` -There are two main options for the rule: - -* `{"enforceDynamicLinks": "always"}` enforces the rule if the href is a dynamic link (default) -* `{"enforceDynamicLinks": "never"}` does not enforce the rule if the href is a dynamic link - +* enabled: for enabling the rule. 0=off, 1=warn, 2=error. Defaults to 0. +* enforce: optional string, 'always' or 'never' ### always (default) +`{"enforceDynamicLinks": "always"}` enforces the rule if the href is a dynamic link (default) When {"enforceDynamicLinks": "always"} is set, the following patterns are considered errors: @@ -40,6 +43,8 @@ var Hello = ### never +`{"enforceDynamicLinks": "never"}` does not enforce the rule if the href is a dynamic link + When {"enforceDynamicLinks": "never"} is set, the following patterns are **not** considered errors: ```jsx @@ -48,4 +53,4 @@ var Hello = ## When Not To Use It -If you do not have any external links, you can disable this rule +If you do not have any external links, you can disable this rule \ No newline at end of file