Skip to content

Commit

Permalink
fix(js): rename js lib to be @kitware/trame-iframe
Browse files Browse the repository at this point in the history
  • Loading branch information
jourdain committed Dec 13, 2024
1 parent fcda6d3 commit 4a181b3
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions js-lib/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Trame iframe client library for plain JS
# Trame iframe library for plain JS
This library aims to simplify interaction between a trame application living inside an iframe and its iframe parent.
This work is inspired by the [official trame-client js lib](https://github.com/Kitware/trame-client/tree/master/js-lib)

Expand All @@ -8,7 +8,7 @@ This work is inspired by the [official trame-client js lib](https://github.com/K
## Usage
First you need to grab the iframe that contains your trame application.
```js
import ClientCommunicator from "@kitware/trame-iframe-client";
import ClientCommunicator from "@kitware/trame-iframe";

const iframe = document.getElementById("trame_app");
const iframe_url = "http://localhost:3000";
Expand Down
2 changes: 1 addition & 1 deletion js-lib/examples/vite/client/main.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import ClientCommunicator from "@kitware/trame-iframe-client";
import ClientCommunicator from "@kitware/trame-iframe";
import "./style.css";
import { setupCounter } from "./counter.js";

Expand Down
2 changes: 1 addition & 1 deletion js-lib/examples/vite/client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@
"vite": "^5.2.0"
},
"dependencies": {
"@kitware/trame-iframe-client": "^0.0.1"
"@kitware/trame-iframe": "latest"
}
}
10 changes: 5 additions & 5 deletions js-lib/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions js-lib/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kitware/trame-iframe-client",
"version": "0.0.1",
"name": "@kitware/trame-iframe",
"version": "0.0.2",
"license": "Apache-2.0",
"main": "./dist/trame-iframe.umd.js",
"unpkg": "./dist/trame-iframe.umd.js",
Expand Down

0 comments on commit 4a181b3

Please sign in to comment.