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

docs(importmaps): use importmaps for external script #3200

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

daker
Copy link
Collaborator

@daker daker commented Jan 1, 2025

Context

Recommend the use of importmaps

Results

Changes

  • Documentation and TypeScript definitions were updated to match those changes

PR and Code Checklist

  • semantic-release commit messages
  • Run npm run reformat to have correctly formatted code

Testing

  • This change adds or fixes unit tests
  • Tested environment:
    • vtk.js:
    • OS:
    • Browser:

Copy link
Member

@finetjul finetjul left a comment

Choose a reason for hiding this comment

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

There are other places that reference https://unpkg.com/vtk.js, you might want to modify those as well...

@floryst should we mention both options ? with and without import maps ?

@daker daker force-pushed the docs-import-maps branch from a607867 to e7023df Compare January 2, 2025 10:30
@daker daker force-pushed the docs-import-maps branch from e7023df to e3b5626 Compare January 2, 2025 10:32
Copy link
Member

@finetjul finetjul left a comment

Choose a reason for hiding this comment

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

LGTM

@finetjul finetjul requested a review from floryst January 2, 2025 11:05
Copy link
Collaborator

@floryst floryst left a comment

Choose a reason for hiding this comment

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

Overall looks good. I would like to request that we add the ES module code in addition to the UMD bundle. We can have two headings, such as "Using ES Modules" and "Using the UMD bundle", in that order.

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.

3 participants