-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: migrate docs to RSPress (#1617)
* chore: copy Re.pack docs * chore: global configs * docs: migrate getting started * chore: migrate intro * docs: move migration guides * chore: remove some unused things * docs: move API * docs: re-organize docs * docs: re-organize * chore: fix file refs * docs: tweaks and fixes * docs: reorganize docs * chore: replace website * chore: deploy script
- Loading branch information
1 parent
4c9a8e1
commit 3cdfb85
Showing
68 changed files
with
4,275 additions
and
13,355 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,25 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
lerna-debug.log* | ||
|
||
node_modules | ||
dist | ||
dist-ssr | ||
*.local | ||
|
||
# Yarn 4.x | ||
.pnp.* | ||
.yarn/* | ||
!.yarn/patches | ||
!.yarn/plugins | ||
!.yarn/releases | ||
!.yarn/sdks | ||
!.yarn/versions | ||
# Editor directories and files | ||
.vscode/* | ||
!.vscode/extensions.json | ||
.idea | ||
.DS_Store | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? | ||
doc_build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
module.exports = { | ||
singleQuote: true, | ||
trailingComma: 'es5', | ||
overrides: [ | ||
{ | ||
files: '*.css', | ||
options: { | ||
printWidth: 120, | ||
}, | ||
}, | ||
], | ||
}; |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[ | ||
{ | ||
"text": "Examples", | ||
"link": "https://github.com/callstack/react-native-testing-library/tree/main/examples" | ||
} | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
[ | ||
{ | ||
"type": "dir", | ||
"name": "start", | ||
"label": "Getting started" | ||
}, | ||
{ "type": "dir", "name": "api", "label": "API reference" }, | ||
{ | ||
"type": "dir", | ||
"name": "guides", | ||
"label": "Guides" | ||
}, | ||
{ | ||
"type": "dir", | ||
"name": "advanced", | ||
"label": "Advanced Guides" | ||
}, | ||
{ | ||
"type": "dir", | ||
"name": "migration", | ||
"label": "Migration Guides", | ||
"collapsed": true | ||
} | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
["testing-env", "understanding-act"] |
7 changes: 3 additions & 4 deletions
7
website/docs/TestingEnvironment.md → ...e/docs/12.x/docs/advanced/testing-env.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 1 addition & 8 deletions
9
website/docs/UnderstandingAct.md → .../12.x/docs/advanced/understanding-act.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
uri: /api | ||
--- | ||
# API Overview | ||
|
||
React Native Testing Library consists of following APIs: | ||
|
||
- [`render` function](docs/api/render) - render your UI components for testing purposes | ||
- [`screen` object](docs/api/screen) - access rendered UI: | ||
- [Queries](docs/api/queries) - find relevant components by various predicates: role, text, test ids, etc | ||
- Lifecycle methods: [`rerender`](docs/api/screen#rerender), [`unmount`](docs/api/screen#unmount) | ||
- Helpers: [`debug`](docs/api/screen#debug), [`toJSON`](docs/api/screen#tojson), [`root`](docs/api/screen#root) | ||
- [Jest matchers](docs/api/jest-matchers) - validate assumptions about your UI | ||
- [User Event](docs/api/events/user-event) - simulate common user interactions like [`press`](docs/api/events/user-event#press) or [`type`](docs/api/events/user-event#type) in a realistic way | ||
- [Fire Event](docs/api/events/fire-event) - simulate any component event in a simplified way | ||
purposes | ||
- Misc APIs: | ||
- [`renderHook` function](docs/api/misc/render-hook) - render hooks for testing | ||
- [Async utils](docs/api/misc/async): `findBy*` queries, `wait`, `waitForElementToBeRemoved` | ||
- [Configuration](docs/api/misc/config): `configure`, `resetToDefaults` | ||
- [Accessibility](docs/api/misc/accessibility): `isHiddenFromAccessibility` | ||
- [Other](docs/api/misc/other): `within`, `act`, `cleanup` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[ | ||
{ "type": "file", "name": "render", "label": "Render function" }, | ||
{ "type": "file", "name": "screen", "label": "Screen object" }, | ||
"queries", | ||
"jest-matchers", | ||
{ "type": "dir", "name": "events", "label": "Triggering events" }, | ||
{ "type": "dir", "name": "misc", "label": "Miscellaneous" } | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
[ | ||
{ "type": "file", "name": "user-event", "label": "User Event" }, | ||
{ "type": "file", "name": "fire-event", "label": "Fire Event" } | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.