Skip to content

Commit cd21cdb

Browse files
committed
docs(TypeScript): outline recommended TypeScript version, downgrade ts to v4.7.x
1 parent c9912c7 commit cd21cdb

File tree

5 files changed

+21
-18
lines changed

5 files changed

+21
-18
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ You can find our documentation under the following links:
6464
## Requirements
6565

6666
- [React](https://www.npmjs.com/package/react) and [React-DOM](https://www.npmjs.com/package/react-dom) (**16.14.0 or higher**)
67-
- [Node.js](https://nodejs.org/) (**version 14 or higher** ⚠️)
67+
- [Node.js](https://nodejs.org/) (**version 16 or higher** ⚠️)
68+
- If you're using [TypeScript](https://www.typescriptlang.org/) we recommend version **4.7** or later.
6869

6970
<!-- *********************************************************************** -->
7071

docs/Welcome.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ In addition to that, UI5 Web Components for React is providing complex component
2626
## Requirements
2727

2828
- [React](https://www.npmjs.com/package/react) and [React-DOM](https://www.npmjs.com/package/react-dom) (**16.14.0 or higher**)
29-
- [Node.js](https://nodejs.org/) (**version 14 or higher** ⚠️)
29+
- [Node.js](https://nodejs.org/) (**version 16 or higher** ⚠️)
30+
- If you're using [TypeScript](https://www.typescriptlang.org/) we recommend version **4.7** or later.
3031

3132
## Getting Started
3233

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
"storybook": "7.0.9",
8484
"turndown": "^7.0.0",
8585
"typedoc": "^0.24.0",
86-
"typescript": "5.0.4",
86+
"typescript": "~4.7.0",
8787
"vite": "^4.1.1",
8888
"vite-plugin-istanbul": "^4.0.0",
8989
"vite-tsconfig-paths": "^4.0.5"

packages/base/src/hooks/useIsRTL.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ const detectRTL = <RefType extends HTMLElement>(elementRef: RefObject<RefType>)
1919
if (dirValues.includes(locallyAppliedDir)) {
2020
return locallyAppliedDir === 'rtl';
2121
}
22+
// @ts-expect-error: `.includes` returns false if searching for undefined - the ts-error is fixed in a later version of ts
2223
if (dirValues.includes(elementRef.current?.dir)) {
2324
return elementRef.current?.dir === 'rtl';
2425
}

yarn.lock

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21647,16 +21647,6 @@ __metadata:
2164721647
languageName: node
2164821648
linkType: hard
2164921649

21650-
"typescript@npm:5.0.4":
21651-
version: 5.0.4
21652-
resolution: "typescript@npm:5.0.4"
21653-
bin:
21654-
tsc: bin/tsc
21655-
tsserver: bin/tsserver
21656-
checksum: 82b94da3f4604a8946da585f7d6c3025fff8410779e5bde2855ab130d05e4fd08938b9e593b6ebed165bda6ad9292b230984f10952cf82f0a0ca07bbeaa08172
21657-
languageName: node
21658-
linkType: hard
21659-
2166021650
"typescript@npm:^3 || ^4":
2166121651
version: 4.9.5
2166221652
resolution: "typescript@npm:4.9.5"
@@ -21667,13 +21657,13 @@ __metadata:
2166721657
languageName: node
2166821658
linkType: hard
2166921659

21670-
"typescript@patch:[email protected]#~builtin<compat/typescript>":
21671-
version: 5.0.4
21672-
resolution: "typescript@patch:typescript@npm%3A5.0.4#~builtin<compat/typescript>::version=5.0.4&hash=b5f058"
21660+
"typescript@npm:~4.7.0":
21661+
version: 4.7.4
21662+
resolution: "typescript@npm:4.7.4"
2167321663
bin:
2167421664
tsc: bin/tsc
2167521665
tsserver: bin/tsserver
21676-
checksum: d26b6ba97b6d163c55dbdffd9bbb4c211667ebebc743accfeb2c8c0154aace7afd097b51165a72a5bad2cf65a4612259344ff60f8e642362aa1695c760d303ac
21666+
checksum: 5750181b1cd7e6482c4195825547e70f944114fb47e58e4aa7553e62f11b3f3173766aef9c281783edfd881f7b8299cf35e3ca8caebe73d8464528c907a164df
2167721667
languageName: node
2167821668
linkType: hard
2167921669

@@ -21687,6 +21677,16 @@ __metadata:
2168721677
languageName: node
2168821678
linkType: hard
2168921679

21680+
"typescript@patch:typescript@~4.7.0#~builtin<compat/typescript>":
21681+
version: 4.7.4
21682+
resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin<compat/typescript>::version=4.7.4&hash=65a307"
21683+
bin:
21684+
tsc: bin/tsc
21685+
tsserver: bin/tsserver
21686+
checksum: 9096d8f6c16cb80ef3bf96fcbbd055bf1c4a43bd14f3b7be45a9fbe7ada46ec977f604d5feed3263b4f2aa7d4c7477ce5f9cd87de0d6feedec69a983f3a4f93e
21687+
languageName: node
21688+
linkType: hard
21689+
2169021690
"typical@npm:^4.0.0":
2169121691
version: 4.0.0
2169221692
resolution: "typical@npm:4.0.0"
@@ -21773,7 +21773,7 @@ __metadata:
2177321773
tocbot: ^4.12.0
2177421774
turndown: ^7.0.0
2177521775
typedoc: ^0.24.0
21776-
typescript: 5.0.4
21776+
typescript: ~4.7.0
2177721777
vite: ^4.1.1
2177821778
vite-plugin-istanbul: ^4.0.0
2177921779
vite-tsconfig-paths: ^4.0.5

0 commit comments

Comments
 (0)