-
-
Notifications
You must be signed in to change notification settings - Fork 62
Support for embedding source in kicanvas-source #126
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,7 +15,12 @@ import { | |
import { KCUIElement } from "../../kc-ui"; | ||
import kc_ui_styles from "../../kc-ui/kc-ui.css"; | ||
import { Project } from "../project"; | ||
import { FetchFileSystem, VirtualFileSystem } from "../services/vfs"; | ||
import { | ||
FetchFileSystem, | ||
VirtualFileSystem, | ||
MemoryFileSystem, | ||
CombinedFileSystem, | ||
} from "../services/vfs"; | ||
import type { KCBoardAppElement } from "./kc-board/app"; | ||
import type { KCSchematicAppElement } from "./kc-schematic/app"; | ||
|
||
|
@@ -98,27 +103,70 @@ class KiCanvasEmbedElement extends KCUIElement { | |
async #setup_events() {} | ||
|
||
async #load_src() { | ||
const sources = []; | ||
const url_sources: (string | URL)[] = []; | ||
const inline_entries: Record<string, string> = {}; | ||
const counters: Record<string, number> = {}; | ||
|
||
if (this.src) { | ||
sources.push(this.src); | ||
url_sources.push(this.src); | ||
} | ||
|
||
for (const src_elm of this.querySelectorAll<KiCanvasSourceElement>( | ||
"kicanvas-source", | ||
)) { | ||
if (src_elm.src) { | ||
sources.push(src_elm.src); | ||
url_sources.push(src_elm.src); | ||
continue; | ||
} | ||
|
||
const content = src_elm.textContent?.trim(); | ||
if (!content) { | ||
continue; | ||
} | ||
|
||
let filename = src_elm.name?.trim(); | ||
if (!filename || filename.length == 0) { | ||
const type = (src_elm.type ?? "schematic").toLowerCase(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similarly to the comment above I've changed this to |
||
let ext = "kicad_sch"; | ||
if (type == "board") { | ||
ext = "kicad_pcb"; | ||
} else if (type == "project") { | ||
ext = "kicad_pro"; | ||
} | ||
counters[ext] = (counters[ext] ?? 0) + 1; | ||
const index = counters[ext]; | ||
filename = `inline_${index}.${ext}`; | ||
} | ||
|
||
inline_entries[filename] = content; | ||
} | ||
|
||
if (sources.length == 0) { | ||
if ( | ||
url_sources.length == 0 && | ||
Object.keys(inline_entries).length == 0 | ||
) { | ||
console.warn("No valid sources specified"); | ||
return; | ||
} | ||
|
||
const vfs = new FetchFileSystem(sources, this.custom_resolver); | ||
await this.#setup_project(vfs); | ||
// Prefer loading inline sources; combine with URLs if both provided. | ||
if (Object.keys(inline_entries).length && url_sources.length) { | ||
const vfs = new CombinedFileSystem([ | ||
new MemoryFileSystem(inline_entries), | ||
new FetchFileSystem(url_sources, this.custom_resolver), | ||
]); | ||
await this.#setup_project(vfs); | ||
return; | ||
} | ||
|
||
if (Object.keys(inline_entries).length) { | ||
await this.#setup_project(new MemoryFileSystem(inline_entries)); | ||
return; | ||
} | ||
|
||
await this.#setup_project( | ||
|
||
new FetchFileSystem(url_sources, this.custom_resolver), | ||
); | ||
} | ||
|
||
async #setup_project(vfs: VirtualFileSystem) { | ||
|
@@ -182,6 +230,14 @@ class KiCanvasSourceElement extends CustomElement { | |
|
||
@attribute({ type: String }) | ||
src: string | null; | ||
|
||
// Optional filename to use when providing inline content | ||
@attribute({ type: String }) | ||
name: string | null; | ||
|
||
// Hint for inline content type: schematic|board|project | ||
@attribute({ type: String }) | ||
type: "schematic" | "board" | "project" | null; | ||
} | ||
|
||
window.customElements.define("kicanvas-source", KiCanvasSourceElement); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because
querySelectorAll
is used, the custom element property is not reliably accessible and may return undefined at runtime. To address this problem,getAttribute
should be used on the returned element.I've changed this to
src_elm.getAttribute('name')?.trim()
in my local copy to resolve the issue.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting - I'm wondering if this is executing before the element has finished being registered?