diff --git a/docs/rules/split-platform-components.md b/docs/rules/split-platform-components.md index 9d2dcc8..fd49da3 100644 --- a/docs/rules/split-platform-components.md +++ b/docs/rules/split-platform-components.md @@ -101,3 +101,30 @@ export default function Hello() { return } ``` + +## Rule Options + +```js +... +"react-native/split-platform-components": [ , { + androidPathRegex: , + iosPathRegex: +}] +... +``` + +### `androidPathRegex` + +A RegExp pattern to use for Android platform components. You can include other custom filenames like so: + +```js +'react-native/split-platform-components': [2, {androidPathRegex: '\\.android.(js|jsx|ts|tsx)$'}] +``` + +### `iosPathRegex` + +A RegExp pattern to use for iOS platform components. You can include other custom filenames like so: + +```js +'react-native/split-platform-components': [2, {iosPathRegex: '\\.ios.(js|jsx|ts|tsx)$'}] +```