semi-design icon indicating copy to clipboard operation
semi-design copied to clipboard

feat: improve document for select/popover about `getPopupContainer` API

Open so2liu opened this issue 2 years ago • 2 comments

中文模板 / Chinese Template

What kind of change does this PR introduce? (check at least one)

  • [ ] Bugfix
  • [ ] Feature
  • [ ] Code style update
  • [ ] Refactor
  • [ ] Test Case
  • [ ] TypeScript definition update
  • [x] Document improve
  • [ ] CI/CD improve
  • [ ] Branch sync
  • [ ] Other, please describe:

PR description

Fixes #

Changelog

🇨🇳 Chinese

  • Feat: 改善了select/popover组件中getPopupContainer的API描述,并给出了例子。参考了antd的文档,之前版本的文档只描述了这个API做什么,没有描述什么时候会用到,且不是那么直观。

🇺🇸 English

  • Feat: Improve the API description of getPopupContainer about select/popover element. And give an example. Refererence to antd document, previous version of document only describes the behavior of API, while the use situation is missing and without intuition.

Checklist

  • [x] Test or no need
  • [ ] Document or no need
  • [ ] Changelog or no need

Other

  • [ ] Skip Changelog

Additional information

so2liu avatar Apr 09 '22 14:04 so2liu

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 78e1ba0aafa57c3872e00cd0e84587cc73a2fa6c:

Sandbox Source
pr-story Configuration
Semi Design: Simple Story Configuration

codesandbox-ci[bot] avatar Apr 09 '22 14:04 codesandbox-ci[bot]

Codecov Report

Merging #754 (ab3dd2c) into main (44ff9e0) will increase coverage by 0.00%. The diff coverage is 100.00%.

:exclamation: Current head ab3dd2c differs from pull request most recent head 98fff88. Consider uploading reports for the commit 98fff88 to get more accurate results

@@           Coverage Diff           @@
##             main     #754   +/-   ##
=======================================
  Coverage   79.90%   79.90%           
=======================================
  Files         431      431           
  Lines       22093    22094    +1     
  Branches     5668     5668           
=======================================
+ Hits        17653    17654    +1     
  Misses       4419     4419           
  Partials       21       21           
Impacted Files Coverage Δ
packages/semi-ui/tagInput/index.tsx 92.19% <ø> (ø)
packages/semi-foundation/tagInput/foundation.ts 91.20% <100.00%> (+0.09%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 44ff9e0...98fff88. Read the comment docs.

codecov-commenter avatar Apr 09 '22 14:04 codecov-commenter