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.

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

feat: add @scalar/api-reference-editor #1490

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

geoffgscott
Copy link
Contributor

@geoffgscott geoffgscott commented Apr 23, 2024

This adds in an editable version of the references (ESM only).

You can import the vue component OR mountApiReferenceEditable to create an editable version of the references. For CDN delivery we may want to consider bundling Vue with the package. Otherwise import maps would have to be used (which is also well supported).

PR also includes a very light refactor to the way Layouts are imported into APIReference. This provides a single component that can be used.

Copy link

changeset-bot bot commented Apr 23, 2024

⚠️ No Changeset found

Latest commit: 52f6ae9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@marclave marclave requested a review from amritk April 23, 2024 01:48
@geoffgscott geoffgscott force-pushed the geoff/doc-1689-editor-not-displaying branch from 940925a to 52f6ae9 Compare April 23, 2024 14:55
Copy link
Contributor

Copy link

relativeci bot commented Apr 23, 2024

Job #1066: Bundle Size — 1.92MiB (+0.03%).

52f6ae9(current) vs 1b6cb7c main#1064(baseline)

Warning

Bundle contains 4 duplicate packages – View duplicate packages

Bundle metrics  Change 3 changes Regression 1 regression
                 Current
Job #1066
     Baseline
Job #1064
Regression  Initial JS 1.92MiB(+0.03%) 1.92MiB
No change  Initial CSS 0B 0B
Change  Cache Invalidation 100% 0%
No change  Chunks 1 1
No change  Assets 1 1
Change  Modules 1043(+0.1%) 1042
No change  Duplicate Modules 0 0
No change  Duplicate Code 0% 0%
No change  Packages 158 158
No change  Duplicate Packages 4 4
Bundle size by type  Change 1 change Regression 1 regression
                 Current
Job #1066
     Baseline
Job #1064
Regression  JS 1.92MiB (+0.03%) 1.92MiB

View job #1066 reportView geoff/doc-1689-editor-not-displa... branch activityView project dashboard

@marclave marclave requested review from hwkr and hanspagel April 25, 2024 14:31
@toggleDarkMode="() => toggleDarkMode()"
@updateContent="handleContentChange">
<template #editor>
<!-- -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Intentional empty comment?

Comment on lines +162 to +166
<style>
body {
margin: 0;
}
</style>
Copy link
Member

Choose a reason for hiding this comment

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

That’s part of the theme anyway, isn’t it? I think we can remove it.


setTimeout(
() =>
updateSpecValue(`openapi: 3.0.3
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can use the new Scalar galaxy example here, usage examples here:

#1539 (was merged just now)

@hanspagel hanspagel changed the title feat: Add in API References editor feat: add @scalar/api-reference-editor May 6, 2024
@hanspagel hanspagel self-assigned this May 6, 2024
@hanspagel
Copy link
Member

I’ll take this one over and bring it over the finish line. 🏃

@hanspagel hanspagel marked this pull request as draft May 6, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants