-
Notifications
You must be signed in to change notification settings - Fork 10.3k
[Docs Site] Support EC props in GitHubCode and TypeScriptExample #20267
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
src/content/docs/style-guide/components/typescript-example.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| title: TypeScript example | ||
| --- | ||
|
|
||
| ## TypeScript examples | ||
|
|
||
| The `TypeScriptExample` component uses [`ts-blank-space`](https://github.com/bloomberg/ts-blank-space) to remove TypeScript-specific syntax from your example and provide a JavaScript tab. This reduces maintenance burden by only having a single example to maintain. | ||
|
|
||
| This component is automatically used in the [`GitHubCode`](/style-guide/components/github-code/) component when the `lang` is set to `ts`. | ||
|
|
||
| :::note | ||
| Some TypeScript syntax influences runtime behaviour, and cannot be stripped. | ||
|
|
||
| Please refer to the [Unsupported Syntax](https://github.com/bloomberg/ts-blank-space?tab=readme-ov-file#unsupported-syntax) section of the project's README. | ||
| ::: | ||
|
|
||
| ## Component | ||
|
|
||
| ````mdx live | ||
| import { TypeScriptExample } from "~/components"; | ||
|
|
||
| <TypeScriptExample> | ||
| ```ts | ||
| interface Environment { | ||
| KV: KVNamespace; | ||
| } | ||
|
|
||
| export default { | ||
| async fetch(req, env, ctx): Promise<Response> { | ||
| if (req !== "POST") { | ||
| return new Response("Method Not Allowed", { | ||
| status: 405, | ||
| headers: { | ||
| "Allow": "POST" | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| await env.KV.put("foo", "bar"); | ||
|
|
||
| return new Response(); | ||
| } | ||
| } satisfies ExportedHandler<Environment> | ||
| ``` | ||
| </TypeScriptExample> | ||
| ```` | ||
|
|
||
|
|
||
| ## `<TypeScriptExample>` Props | ||
|
|
||
| ### `filename` | ||
|
|
||
| **type:** `string` | ||
|
|
||
| An optional filename, ending in `.ts`. | ||
|
|
||
| `.ts` will be replaced by `.js` for the JavaScript tab. | ||
|
|
||
| ### `playground` | ||
|
|
||
| **type:** `boolean` | ||
|
|
||
| If set to `true`, a [`Run Worker in Playground`](/style-guide/components/code/#playground) button will appear on the JavaScript tab. | ||
|
|
||
| ### `code` | ||
|
|
||
| **type**: `object` | ||
|
|
||
| Props to pass to the [Expressive Code component](https://expressive-code.com/key-features/code-component/). | ||
|
|
||
| These props will apply to both code blocks and so options like `collapse` may not work as expected, as lines may be removed from the TypeScript code. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.