-
Notifications
You must be signed in to change notification settings - Fork 81
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
feat: added link component #266
Changes from 3 commits
a1c02c1
db4b403
e624faa
963b48e
c700657
28dacc9
1ba6a76
952dd95
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 |
---|---|---|
@@ -0,0 +1,83 @@ | ||
<template> | ||
<div class="CoreLink"> | ||
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. Since you're working on links, can you please check how the Markdown links are working, if everything is alright with them? I assume that with a Text component, markdown mode, I can 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. Just checked and yes - you can. You can also 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. So it's basically the same, only difference is that you can select page in component and define rel and target. 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. Thanks for checking! Yes they're quite similar, that's what kept me from creating this component. However, now that I think more about it:
By the way there's the possibility of opening URLs from the backend via backend actions too. |
||
<a | ||
:href="fields.url.value" | ||
:target="fields.target.value" | ||
:rel="fields.rel.value" | ||
> | ||
{{ displayText }} | ||
</a> | ||
</div> | ||
</template> | ||
|
||
<script lang="ts"> | ||
import { FieldType, Core } from "../../streamsyncTypes"; | ||
import { cssClasses, primaryTextColor } from "../../renderer/sharedStyleFields"; | ||
import injectionKeys from "../../injectionKeys"; | ||
export default { | ||
streamsync: { | ||
name: "Link", | ||
description: "A component to create a hyperlink.", | ||
category: "Content", | ||
fields: { | ||
url: { | ||
name: "URL", | ||
type: FieldType.Text, | ||
desc: "A valid URL.", | ||
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. I was quite confused by the list of pages at first, when I got to try this component. Took me a while to be like "Ah, of course, the pages are accessible via #". I love the new dynamic options capability, but it makes you think the right options are the ones listed, when I expect most people to enter a "standard" URL e.g. "github.com". If we keep it:
I'm also not sure how it'd behave when the list is empty, needs checking. I expect most apps to not have any keyed pages. Also, something to keep in mind... The hash can contain parameters that will be lost when switching pages this way. https://www.streamsync.cloud/page-routes.html#routes-with-parameters For example if you have If someone types I'm more inclined towards not keeping the dynamic options here, but they'd certainly come in handy for Reuse Component. 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. The logic that manages the hash is in 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. I see that we've been explicitly asked to link pages. So maybe let's try how it'd look like with the minor changes I suggested under "If we keep it".
Keen to hear your thoughts. Apologies for the verbosity, you probably weren't expecting an essay after submitting a PR for an 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. I think it's just how these kinds of links work. Personally, it would be really confusing for me if the link appended parameters at the end of the URL. I expect that most people using this app will have at least a really basic knowledge about HTML, and |
||
options: (ss: Core) => { | ||
return Object.fromEntries( | ||
ss | ||
.getComponents("root", true) | ||
.map((page) => page.content.key) | ||
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. Careful with this one. Like I was saying earlier not all pages will have keys. In fact I expect most pages to not have keys. 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. Ah sorry didn't see the next line 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. thats why there is filter in the next line |
||
.filter((key) => Boolean(key)) | ||
.map((key) => [`#${key}`, key]), | ||
); | ||
}, | ||
}, | ||
target: { | ||
name: "Target", | ||
type: FieldType.Text, | ||
options: { | ||
_self: "Self", | ||
_blank: "Blank", | ||
_parent: "Parent", | ||
_top: "Top", | ||
}, | ||
desc: "Specifies where to open the linked document.", | ||
default: "_self", | ||
}, | ||
rel: { | ||
name: "Rel", | ||
type: FieldType.Text, | ||
desc: "Specifies the relationship between the current document and the linked document.", | ||
}, | ||
text: { | ||
name: "Text", | ||
default: "", | ||
type: FieldType.Text, | ||
desc: "The text to display in the link.", | ||
}, | ||
primaryTextColor, | ||
cssClasses, | ||
}, | ||
}, | ||
}; | ||
</script> | ||
|
||
<script setup lang="ts"> | ||
import { inject, computed } from "vue"; | ||
const fields = inject(injectionKeys.evaluatedFields); | ||
|
||
const displayText = computed(() => { | ||
return fields.text.value || fields.url.value || "Link"; | ||
raaymax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
}); | ||
</script> | ||
|
||
<style scoped> | ||
.CoreLink a { | ||
color: var(--primaryTextColor); | ||
} | ||
.CoreLink.beingEdited:not(.selected) a { | ||
raaymax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
pointer-events: none; | ||
} | ||
</style> |
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.
Hey @FabienArcellier check this out
@raaymax worked on a dynamic list of options. You can pass it hardcoded options (as we do now), but you can also pass it a function to generate the options.
This was one of the challenges I saw for the Reuse Component component. So with this we're halfway there. I've asked him to work on Reuse Component.
@raaymax for your reference #215
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.
By the way I'm talking specifically about selecting the
id
of the component that we want to reuse.