fix(Select/CustomSelect): Allow to use custom options in renderOption prop #6076

mendrew · 2023-11-03T12:58:33Z

close [Bug]: Ошибка при попытке расширить CustomSelectOptionInterface #6072

Unit-тесты - добавлен тест для проверки случаев использования CustomSelect с расширенными опциями. В основном, чтобы поймать ошибку типов.

Описание

Мы вроде бы позволяем использовать опции любых типов, которые бы имели у себя обязательные свойста Select,

VKUI/packages/vkui/src/components/CustomSelect/CustomSelect.tsx

Lines 107 to 112 in 3a844db

    
           export interface CustomSelectOptionInterface { 
        
             value: SelectValue; 
        
             label: React.ReactElement | string; 
        
             disabled?: boolean; 
        
             [index: string]: any; 
        
           }

но сейчас TS ругается если мы пытаемся использовать в renderOption опции со свойствами, которых нету в CustomSelectOptionInterface.

Изменения

Добавили дженерик для типа опций с constraint, чтобы можно было использовать расширинный тип опции с обязательными полями.

github-actions · 2023-11-03T13:02:29Z

size-limit report 📦

Path	Size
JS	332.4 KB (+0.01% 🔺)
JS (gzip)	101.56 KB (+0.01% 🔺)
JS (brotli)	83.79 KB (-0.08% 🔽)
JS import Div (tree shaking)	2.71 KB (0%)
CSS	255.17 KB (0%)
CSS (gzip)	33.55 KB (0%)
CSS (brotli)	27.25 KB (0%)

codesandbox-ci · 2023-11-03T13:03:03Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 97266e9:

Sandbox	Source
VKUI TypeScript	Configuration
pensive-boyd-y48z99	Issue #6072

github-actions · 2023-11-03T13:05:22Z

e2e tests

Playwright Report

github-actions · 2023-11-03T13:05:41Z

👀 Docs deployed

✅ Styleguide
✅ Storybook

Commit 97266e9

codecov · 2023-11-03T13:06:26Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (3a844db) 79.26% compared to head (97266e9) 79.34%.
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6076      +/-   ##
==========================================
+ Coverage   79.26%   79.34%   +0.07%     
==========================================
  Files         306      306              
  Lines        9612     9620       +8     
  Branches     3254     3256       +2     
==========================================
+ Hits         7619     7633      +14     
+ Misses       1993     1987       -6

Flag	Coverage Δ
unittests	`79.34% <93.33%> (+0.07%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
packages/vkui/src/components/Select/Select.tsx	`78.57% <100.00%> (+1.64%)`	⬆️
packages/vkui/src/lib/select.ts	`89.65% <100.00%> (ø)`
.../vkui/src/components/CustomSelect/CustomSelect.tsx	`86.14% <88.88%> (-0.22%)`	⬇️

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Because it's not possible to assing to generic constrain

inomdzhon

master

ой, *main то есть

… prop (#6076) Мы вроде бы позволяем использовать опции любых типов, которые бы имели у себя обязательные свойста Select, https://github.com/VKCOM/VKUI/blob/3a844db48dea7a4d83d2b9020c2bf21ba18a3344/packages/vkui/src/components/CustomSelect/CustomSelect.tsx#L107-L112 но сейчас TS ругается если мы пытаемся использовать в `renderOption` опции со свойствами, которых нету в `CustomSelectOptionInterface`. * Изменения Добавили дженерик для типа опций с constraint, чтобы можно было использовать расширинный тип опции с обязательными полями. Юнит-тест для проверки случаев использования CustomSelect с расширенными опциями. В основном, чтобы поймать ошибку типов.

Allow to use custom options in renderOption prop of CustomSelect

b8f4270

github-actions bot added patch Автоматизация: PR продублируется в ветку последнего минорного релиза для выпуска патча v5 Автоматизация: PR продублируется в ветку v5 labels Nov 3, 2023

mendrew added 3 commits November 3, 2023 16:25

Fix types in lib/select

4e8b45e

Cast defaultOptions array

f35414a

Because it's not possible to assing to generic constrain

Remove generic passing to CustomSelect from Select

97266e9

mendrew marked this pull request as ready for review November 3, 2023 15:37

mendrew requested a review from a team as a code owner November 3, 2023 15:37

inomdzhon approved these changes Nov 7, 2023

View reviewed changes

BlackySoul approved these changes Nov 7, 2023

View reviewed changes

mendrew merged commit 3704d98 into master Nov 7, 2023
46 checks passed

mendrew deleted the mendrew/fix/6072/CustomSelect/allow-to-use-custom-option-in-render-option-function branch November 7, 2023 12:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(Select/CustomSelect): Allow to use custom options in renderOption prop #6076

fix(Select/CustomSelect): Allow to use custom options in renderOption prop #6076

mendrew commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

codesandbox-ci bot commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

codecov bot commented Nov 3, 2023 •

edited

Loading

inomdzhon left a comment •

edited

Loading

	export interface CustomSelectOptionInterface {
	value: SelectValue;
	label: React.ReactElement \| string;
	disabled?: boolean;
	[index: string]: any;
	}

fix(Select/CustomSelect): Allow to use custom options in renderOption prop #6076

fix(Select/CustomSelect): Allow to use custom options in renderOption prop #6076

Conversation

mendrew commented Nov 3, 2023 • edited Loading

Описание

Изменения

github-actions bot commented Nov 3, 2023 • edited Loading

size-limit report 📦

codesandbox-ci bot commented Nov 3, 2023 • edited Loading

github-actions bot commented Nov 3, 2023 • edited Loading

e2e tests

github-actions bot commented Nov 3, 2023 • edited Loading

👀 Docs deployed

codecov bot commented Nov 3, 2023 • edited Loading

Codecov Report

inomdzhon left a comment • edited Loading

Choose a reason for hiding this comment

mendrew commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

codesandbox-ci bot commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

codecov bot commented Nov 3, 2023 •

edited

Loading

inomdzhon left a comment •

edited

Loading