Skip to content

docs: 修复组件 options 类型文档错误 #1740

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
Merged
merged 1 commit into from
Sep 8, 2022
Merged

docs: 修复组件 options 类型文档错误 #1740

merged 1 commit into from
Sep 8, 2022

Conversation

lijinke666
Copy link
Member

👀 PR includes

🔧 Chore

  • Test case
  • Docs / demos update
  • CI / workflow
  • Release version
  • Other ()

📝 Description

组件层 S2Options => SheetComponentOptions

🖼️ Screenshot

Before After
❌ ✅

🔗 Related issue link

🔍 Self-Check before the merge

  • Add or update relevant docs.
  • Add or update relevant demos.
  • Add or update test case.
  • Add or update relevant TypeScript definitions.

@vercel
Copy link

vercel bot commented Sep 8, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
antvis-s2 ✅ Ready (Inspect) Visit Preview Sep 8, 2022 at 4:02AM (UTC)

@github-actions github-actions bot added the pr(documentation) documentation label Sep 8, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2022

Size Change: 0 B

Total Size: 428 kB

ℹ️ View Unchanged
Filename Size
./packages/s2-core/dist/index.min.js 167 kB
./packages/s2-core/dist/style.min.css 389 B
./packages/s2-core/node_modules/@testing-library/dom/dist/@testing-library/dom.cjs.js 21.7 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/@testing-library/dom.esm.js 21.2 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/@testing-library/dom.umd.js 60.3 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/@testing-library/dom.umd.min.js 33.9 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/config.js 1.16 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/DOMElementFilter.js 1.87 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/event-map.js 1.18 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/events.js 1.55 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/get-node-text.js 300 B
./packages/s2-core/node_modules/@testing-library/dom/dist/get-queries-for-element.js 738 B
./packages/s2-core/node_modules/@testing-library/dom/dist/get-user-code-frame.js 810 B
./packages/s2-core/node_modules/@testing-library/dom/dist/helpers.js 1.07 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/index.js 1.14 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/label-helpers.js 1.05 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/matches.js 1.14 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/pretty-dom.js 1.47 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/all-utils.js 337 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/alt-text.js 573 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/display-value.js 713 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/index.js 418 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/label-text.js 1.8 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/placeholder-text.js 491 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/role.js 2.67 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/test-id.js 498 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/text.js 958 B
./packages/s2-core/node_modules/@testing-library/dom/dist/queries/title.js 718 B
./packages/s2-core/node_modules/@testing-library/dom/dist/query-helpers.js 1.81 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/role-helpers.js 2.82 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/screen.js 1.51 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/suggestions.js 1.5 kB
./packages/s2-core/node_modules/@testing-library/dom/dist/wait-for-element-to-be-removed.js 748 B
./packages/s2-core/node_modules/@testing-library/dom/dist/wait-for.js 2.38 kB
./packages/s2-react/dist/index.min.js 64.2 kB
./packages/s2-react/dist/style.min.css 3.21 kB
./packages/s2-vue/dist/index.min.js 20.4 kB
./packages/s2-vue/dist/style.min.css 1.61 kB

compressed-size-action

xingwanying
xingwanying approved these changes Sep 8, 2022
View reviewed changes
Copy link
Member

@xingwanying xingwanying left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG

@codecov
Copy link

codecov bot commented Sep 8, 2022

Codecov Report

Merging #1740 (4fc9425) into master (d55d819) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1740   +/-   ##
=======================================
  Coverage   77.15%   77.15%           
=======================================
  Files         234      234           
  Lines       11453    11453           
  Branches     2427     2427           
=======================================
  Hits         8837     8837           
  Misses       1265     1265           
  Partials     1351     1351

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@lijinke666 lijinke666 merged commit 414ef66 into master Sep 8, 2022
@lijinke666 lijinke666 deleted the fix-options-api branch September 8, 2022 06:27
@stone-lyl stone-lyl mentioned this pull request Sep 8, 2022
Merged
16 tasks
@lijinke666
Copy link
Member Author

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

wjgogogo pushed a commit that referenced this pull request Oct 25, 2023
@lijinke666
docs: 修复组件 options 类型文档错误 (#1740)
0f65fa8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xingwanying xingwanying xingwanying approved these changes

@GaoFuhong GaoFuhong Awaiting requested review from GaoFuhong

@lcx-seima lcx-seima Awaiting requested review from lcx-seima

@serializedowen serializedowen Awaiting requested review from serializedowen

@stone-lyl stone-lyl Awaiting requested review from stone-lyl

@wjgogogo wjgogogo Awaiting requested review from wjgogogo

@YardWill YardWill Awaiting requested review from YardWill

Assignees

@lijinke666 lijinke666

Labels
pr(documentation) documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lijinke666 @xingwanying