Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

plasma-*: Edit docs core and change docs Switch, Checkbox and Radiobox #1232

Merged
merged 2 commits into from
Jun 17, 2024
Merged

plasma-*: Edit docs core and change docs Switch, Checkbox and Radiobox #1232

merged 2 commits into from
Jun 17, 2024

Conversation

iljs
Copy link
Contributor

@iljs iljs commented Jun 5, 2024 •
edited
Loading

Edit docs

  • исправлена документация для компонента Switch, Checkbox и Radiobox
  • изменена работа документации, теперь при генерации файла документации туда добавляются все типы, в том числе и из react
  • в компонент PropsTable добавлен параметр include, который добавляет свойство в документацию, если он является типом из react

What/why changed

Поменял типы в Switch во всех библиотеках, теперь принцип работы аналогичен Checkbox и Radiobox, а также добавил обратную совместимость с core
Изменил импорт типов в Switch во всех библиотеках

Изменил принцип работы генерации доки. Теперь в json сохраняется все типы и обрезка типов из react происходит в самом компоненте

Снимок экрана 2024-06-17 в 11 50 53
📦 Published PR as canary version: Canary Versions

✨ Test out this PR locally via:

npm install @salutejs/[email protected]

npm install @salutejs/[email protected]
npm install @salutejs/[email protected]
npm install @salutejs/[email protected]
npm install @salutejs/[email protected]
npm install @salutejs/[email protected]
# or 
yarn add @salutejs/[email protected]
yarn add @salutejs/[email protected]
yarn add @salutejs/[email protected]
yarn add @salutejs/[email protected]
yarn add @salutejs/[email protected]
yarn add @salutejs/[email protected]

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 5, 2024

Theme Builder app deployed!

https://plasma.sberdevices.ru/pr/plasma-theme-builder-pr-1232/

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 5, 2024 •
edited
Loading

Documentation preview deployed!

website:https://plasma.sberdevices.ru/pr/pr-1232/
caldera-online storybook: https://plasma.sberdevices.ru/pr/pr-1232/caldera-online-storybook/
asdk storybook: https://plasma.sberdevices.ru/pr/pr-1232/asdk-storybook/
b2c storybook: https://plasma.sberdevices.ru/pr/pr-1232/b2c-storybook/
new-hope storybook: https://plasma.sberdevices.ru/pr/pr-1232/new-hope-storybook/
web storybook: https://plasma.sberdevices.ru/pr/pr-1232/web-storybook/
sdds-serv storybook: https://plasma.sberdevices.ru/pr/pr-1232/sdds-serv-storybook/
ui storybook: https://plasma.sberdevices.ru/pr/pr-1232/ui-storybook/

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 5, 2024

⚡ Component performance testing

Result: 🟢 OK

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 5, 2024

⚡ Component performance testing

Result: 🟢 OK

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 6, 2024

⚡ Component performance testing

Result: 🟢 OK

@Yakutoc Yakutoc added the plasma-docs Improvements or additions to documentation label Jun 7, 2024
@iljs iljs marked this pull request as ready for review June 7, 2024 07:28
@github-actions GitHub Actions
Copy link
Contributor

⚡ Component performance testing

Result: 🟢 OK

@Yakutoc Yakutoc changed the title Edit docs core and Change docs Switch, Checkbox and Radiobox plasma-*: Edit docs core and change docs Switch, Checkbox and Radiobox Jun 17, 2024
@Yakutoc
Copy link
Collaborator

Yakutoc commented Jun 17, 2024

@iljs Добавь пожалуйста еще скрины было/стало и вообще будет пушка )

@github-actions GitHub Actions
Copy link
Contributor

⚡ Component performance testing

Result: 🟢 OK

@iljs iljs added this pull request to the merge queue Jun 17, 2024
Merged via the queue into dev with commit d9b90c7 Jun 17, 2024
29 checks passed
@iljs iljs deleted the fix-docs branch June 17, 2024 08:34
@Salute-Eva Salute-Eva mentioned this pull request Jun 26, 2024
Merged
This was referenced Jul 24, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neretin-trike neretin-trike neretin-trike approved these changes

@Yakutoc Yakutoc Yakutoc approved these changes

Assignees

@iljs iljs

Labels
plasma-docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@iljs @Yakutoc @neretin-trike