Skip to content

feat(api-reference): the button ⚡#3236

Merged
marclave merged 64 commits intomainfrom
cam/the-button
Oct 28, 2024
Merged

feat(api-reference): the button ⚡#3236
marclave merged 64 commits intomainfrom
cam/the-button

Conversation

@cameronrohani
Copy link
Copy Markdown
Contributor

@cameronrohani cameronrohani commented Sep 25, 2024 •
edited by coderabbitai bot
Loading

image image

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a sidebar button for improved navigation.
    • Added a WatchModeToggle component to enhance user control over watch functionality.
    • Integrated an OpenApiClientButton for direct access to OpenAPI documentation.

  • Enhancements

    • Improved drag-and-drop functionality with a more responsive design.
    • Updated ImportCollectionModal for better interactivity and visual feedback.
    • Enhanced DarkModeToggle with a modern slider design.
    • Added a new error variant to the ScalarModal for improved visual feedback.

  • Bug Fixes

    • Refined error handling and response management in URL fetching functions.

  • Documentation

    • Updated comments and documentation for clarity on future enhancements.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Sep 25, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: 41ceba4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 17 packages
Name Type
@scalar/api-reference Patch
@scalar/hono-api-reference Patch
@scalar/api-client Patch
@scalar/components Patch
@scalar/oas-utils Patch
@scalar/api-reference-editor Patch
@scalar/api-reference-react Patch
@scalar/cli Patch
@scalar/fastify-api-reference Patch
@scalar/nuxt Patch
@scalar/play-button Patch
@scalar/aspnetcore Patch
@scalar/mock-server Patch
scalar-api-client Patch
@scalar/api-client-react Patch
@scalar/use-codemirror Patch
@scalar/docusaurus Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@relativeci
Copy link
Copy Markdown

relativeci bot commented Sep 25, 2024 •
edited
Loading

#5625 Bundle Size — 2.27MiB (+2.37%).

41ceba4(current) vs 369c2c2 main#5620(baseline)

Warning

Bundle contains 4 duplicate packages – View duplicate packages

Bundle metrics  Change 2 changes Regression 1 regression
                 Current
#5625		      Baseline
#5620
Regression  Initial JS 2.27MiB(+2.37%) 2.22MiB
No change  Initial CSS 0B 0B
No change  Cache Invalidation 100% 100%
No change  Chunks 1 1
No change  Assets 1 1
Change  Modules 1409(+1.88%) 1383
No change  Duplicate Modules 0 0
No change  Duplicate Code 0% 0%
No change  Packages 170 170
No change  Duplicate Packages 4 4
Bundle size by type  Change 1 change Regression 1 regression
                 Current
#5625		      Baseline
#5620
Regression  JS 2.27MiB (+2.37%) 2.22MiB

Bundle analysis report Branch cam/the-button Project dashboard

Generated by RelativeCI Documentation Report issue

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 25, 2024 •
edited
Loading

Preview Examples

https://e0548742-7982-4acc-a111-0fbcd2a6385e--scalar-deploy-preview.netlify.app

@hanspagel hanspagel changed the title feat: the button wip feat(api-reference): the button Sep 25, 2024
@hanspagel hanspagel force-pushed the cam/the-button branch 2 times, most recently from 093b1b6 to 16dc735 Compare October 11, 2024 11:25
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 11, 2024

Preview Examples

https://5d378fce-bba8-415b-920b-5aa0f127eeea--scalar-deploy-preview.netlify.app

@hanspagel
Copy link
Copy Markdown
Member

hanspagel commented Oct 11, 2024 •
edited
Loading

Great work! I’ve added to it:

  • Made a suggestion for the button label
  • “powered by scalar” > “Powered by Scalar”
  • Added a new web API client playground and made it the default playground for @scalar/api-client
  • Moved the button to a separate component, show it only if we have an OpenAPI document URL
  • Made it link to the local API client or the production API client

Development

cd packages/api-reference
pnpm dev

cd packages/api-client
pnpm playground:web
Screenshot 2024-10-11 at 15 18 40

Screenshot 2024-10-15 at 13 55 51

@hanspagel hanspagel changed the title feat(api-reference): the button feat(api-reference): the button ⚡ Oct 11, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 11, 2024

Cloudflare Preview for the API Client

https://cf6b515a.client-980.pages.dev

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 11, 2024

Preview Examples

https://58ac3ac0-9dc9-4e6a-81b8-3f88c48df5b4--scalar-deploy-preview.netlify.app

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 11, 2024

Cloudflare Preview for the API Client

https://699f3900.client-980.pages.dev

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 11, 2024

Preview Examples

https://8644f2f4-2091-4e8f-8a7b-c9d942a79d35--scalar-deploy-preview.netlify.app

@hanspagel hanspagel mentioned this pull request Oct 15, 2024
Closed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 15, 2024

Cloudflare Preview for the API Client

https://07ec173b.client-980.pages.dev

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 15, 2024

Preview Examples

https://dc6a1457-4b78-47fc-bbc5-99145eee4805--scalar-deploy-preview.netlify.app

@marclave marclave marked this pull request as ready for review October 16, 2024 04:03
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 16, 2024 •
edited
Loading

Cloudflare Preview for the API Client

https://d5f24169.client-980.pages.dev

@cameronrohani
Copy link
Copy Markdown
Contributor Author

cameronrohani commented Oct 18, 2024 •
edited
Loading

Scalar API client Scalar API client

@hanspagel hanspagel force-pushed the cam/the-button branch 2 times, most recently from 5042453 to 6d9556a Compare October 22, 2024 11:45
cameronrohani and others added 16 commits October 28, 2024 10:14
@cameronrohani @amritk
(style)api-client: final margin and color polish
d67d847
@marclave @amritk
fix: add check for only localhost
2434c26
@cameronrohani @amritk
(style)api-client: add proper margin values to copy
dc74d2d
@antlio @amritk
style(api-client): fixes import modal error content
5643a5d
@antlio @amritk
fix(api-client): prevents import modal display on inapp draggeg items
ad1c608
@hanspagel @amritk
chore: reset dev script
b5537e9
@hanspagel @amritk
refactor: code style
dfb16a5
@hanspagel @amritk
refactor: code style
4887fd2
@hanspagel @amritk
refactor: rename watchForChanges to watchMode
81b61a1
@hanspagel @amritk
fix: broken link to icons barrel file
0dcf977
@hanspagel @amritk
refactor: rename isRequestToLocalhost to isLocalUrl
c4d5e7d
@hanspagel @amritk
chore: add cors headers to hono openapi endpoint in the example
11748b1
@hanspagel @amritk
refactor: use existing helper to detect local urls
cb80fb8
@hanspagel @amritk
style: improve loading state
f75a92a
@hanspagel @amritk
refactor: move stuff ot separate components
cc0a87c
@cameronrohani @amritk
fix: import overflow x bug
a2bb5b5
amritk and others added 4 commits October 28, 2024 15:11
@amritk @cameronrohani
feat(api-client): moving the button (#3653)
eaaa2c6 
* feat: moved client button to the client

* (style)api-client: pop up modal button

* feat: hans pr comments

* feat: try something

* fix: test env

* fix: hans comments

---------

Co-authored-by: zameron <[email protected]>
@marclave
fix: add utm builder
ec00c17
@marclave
fix: add cursor pointer to button
4d173ea
@marclave
docs(changeset): feat: add the sidebar button
41ceba4
@marclave marclave self-requested a review October 28, 2024 22:36
@marclave marclave dismissed hwkr’s stale review October 28, 2024 22:37

we fixed this

@marclave marclave requested a review from hanspagel October 28, 2024 22:37
@marclave marclave enabled auto-merge (squash) October 28, 2024 22:45
@marclave marclave disabled auto-merge October 28, 2024 22:47
@marclave marclave merged commit ada8545 into main Oct 28, 2024
@marclave marclave deleted the cam/the-button branch October 28, 2024 22:48
@coderabbitai coderabbitai bot mentioned this pull request Oct 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marclave marclave marclave approved these changes

@kelseyll kelseyll kelseyll approved these changes

@amritk amritk Awaiting requested review from amritk amritk is a code owner

@geoffgscott geoffgscott Awaiting requested review from geoffgscott geoffgscott is a code owner

@hwkr hwkr Awaiting requested review from hwkr hwkr is a code owner

@hanspagel hanspagel Awaiting requested review from hanspagel hanspagel is a code owner

+1 more reviewer

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@cameronrohani @hanspagel @marclave @hwkr @kelseyll @antlio @amritk