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.

Sign up for GitHub

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

load stylesheet and javascript script from remote location #151

Merged
merged 2 commits into from
Oct 15, 2023
Merged

load stylesheet and javascript script from remote location #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eaf3071
load stylesheet and javascript script from remote location
FabienArcellier Oct 2, 2023
9731080
load stylesheet and javascript script from remote location
FabienArcellier Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/docs/frontend-scripts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,20 @@ initial_state.import_script("my_script", "/static/script.js")
Importing scripts is useful to import libraries that don't support ES6 modules. When possible, use ES6 modules. The `import_script` syntax is only used for side effects; you'll only be able to call functions from the backend using modules that have been previously imported via `import_frontend_module`.
:::

## Importing a script or stylesheet from a URL

Streamsync can also import scripts and stylesheets from URLs. This is useful for importing libraries from CDNs. The `import_script` and `import_stylesheet` methods take a `url` argument, which is the URL to the script or stylesheet.

```python
initial_state = ss.init_state({
"my_app": {
"title": "My App"
},
})

initial_state.import_script("lodash", "https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.21/lodash.js")
```

## Frontend core

You can access Streamsync's frontend core via `globalThis.core`, unlocking all sorts of functionality. Notably, you can use `getUserState()` to get values from state.
Expand Down
24 changes: 7 additions & 17 deletions ui/src/core_components/CoreRoot.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,33 +185,23 @@ function handleHashChange() {
}

async function importStylesheet(stylesheetKey: string, path: string) {
const req = await fetch(path);
if (req.status > 399) {
console.warn(`Couldn't import stylesheet at "${path}".`);
return;
}
const existingEl = document.querySelector(`[data-streamsync-stylesheet-key="${stylesheetKey}"]`);
existingEl?.remove();
const el = document.createElement("style");
const el = document.createElement("link");
el.dataset.streamsyncStylesheetKey = stylesheetKey;
const cssText = await req.text();
el.textContent = cssText;
document.head.appendChild(el);
el.setAttribute('href', path)
el.setAttribute("rel", "stylesheet");
document.head.appendChild(el);
}

async function importScript(scriptKey: string, path: string) {
const req = await fetch(path);
if (req.status > 399) {
console.warn(`Couldn't import script at "${path}".`);
return;
}
const existingEl = document.querySelector(`[data-streamsync-script-key="${scriptKey}"]`);
existingEl?.remove();
const el = document.createElement("script");
el.dataset.streamsyncScriptKey = scriptKey;
const scriptText = await req.text();
el.textContent = scriptText;
document.head.appendChild(el);
el.src = path;
el.setAttribute("rel", "modulepreload");
document.head.appendChild(el);
}

async function importModule(moduleKey: string, specifier: string) {
Expand Down