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

Displaying TS code examples in the docs #10966

Draft
wants to merge 178 commits into
base: develop
Choose a base branch
from
Draft

Conversation

sequba
Copy link
Contributor

@sequba sequba commented May 8, 2024

Context

This pull request creates the UI that displays the typescript code examples in the docs and add the ability to switch between JS and TS versions.

In the code tab, there will be a dropdown with the available versions of the example (JS and TS in most cases). The source code preview area will display the selected version of the code.

How has this been tested?

To be provided

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature or improvement (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Additional language file or change to the existing one (translations)

Related issue(s):

  1. https://github.com/handsontable/dev-handsontable/issues/1905

Affected project(s):

  • handsontable
  • @handsontable/angular
  • @handsontable/react
  • @handsontable/vue
  • @handsontable/vue3

Checklist:

@sequba sequba marked this pull request as draft May 21, 2024 10:28
@sequba sequba changed the title Typescript code examples Displaying TS code examples in the docs May 21, 2024
Copy link

github-actions bot commented May 22, 2024

Launch the local version of documentation by running:

npm run docs:review f312564d1330726a9a05c978e10ad02bcaad8b46

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

7 participants