-
-
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
Open
LK
wants to merge
2
commits into
theacodes:main
Choose a base branch
from
LK:embedded-source
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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,68 @@ 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); | ||
// Construct VFS based on provided sources, then setup project once. | ||
let vfs: VirtualFileSystem; | ||
|
||
// Prefer loading inline sources; combine with URLs if both provided. | ||
if (Object.keys(inline_entries).length && url_sources.length) { | ||
vfs = new CombinedFileSystem([ | ||
new MemoryFileSystem(inline_entries), | ||
new FetchFileSystem(url_sources, this.custom_resolver), | ||
]); | ||
} else if (Object.keys(inline_entries).length) { | ||
vfs = new MemoryFileSystem(inline_entries); | ||
} else { | ||
vfs = new FetchFileSystem(url_sources, this.custom_resolver); | ||
} | ||
|
||
return await this.#setup_project(vfs); | ||
} | ||
|
||
async #setup_project(vfs: VirtualFileSystem) { | ||
|
@@ -182,6 +228,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); | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?