Docs/Zorn
1
Fork 0
Code Issues Pull requests Activity

Update documentations for new version

Browse source
This commit is contained in:
Korbs 2025-02-05 22:47:26 -05:00
parent ded7d47e1e
commit d3a7d577f7
Signed by: Korbs
SSH key fingerprint: SHA256:Q0b0KraMldpAO9oKa+w+gcsXsOTykQ4UkAKn0ByGn5U
9 changed files with 197 additions and 76 deletions
Download patch file Download diff file Expand all files Collapse all files

79
docs/context-menu.mdx Normal file
View file

@ -0,0 +1,79 @@
---
Title: Context Menu
Type: Document
---
import {Code} from "astro:components"
import {Zorn} from "@minpluto/zorn"
<Zorn
PlayerName="ennie_and_yoyki"
Poster="https://ocean.sudovanilla.org/media/videos/Ennie%20and%20Yoyki/Poster.png"
Video="https://ocean.sudovanilla.org/media/videos/Ennie%20and%20Yoyki/Ennie%20and%20Yoyki:%20Non-Girly%20Games.mp4"
ContextItems={
[
{
"Type": "Button",
"Name": "Copy URL",
"Action": "null",
},
{
"Type": "Link",
"Name": "Copy URL with Timestamp",
"Action": "#",
},
{
"Type": "Link",
"Name": "Copy Embed Code",
"Action": "#",
},
{
"Type": "Link",
"Name": "Troubleshoot Player",
"Action": "#",
}
]
}
/>
> Right-click in the demo above to see it action.
You can override the browser's default context menu by adding your own, this is done with the `ContextItems` variable being added with an array.
Example:
<Code lang="jsx" code={`
<Zorn
ContextItems={
[
{
"Type": "Button",
"Name": "Copy URL",
"Action": "null",
},
{
"Type": "Link",
"Name": "Copy Embed Code",
"Action": "#",
},
{
"Type": "Separator"
},
{
"Type": "Link",
"Name": "Troubleshoot Player",
"Action": "#",
}
]
}
/>
`}/>
If the `ContextItems` variable is not applied, Zorn will default to the browser's default context menu.
| Variable | Option |
|--------------------|---------------------------------------------------------------|
| Type | `Button`, `Link`, or `Separator` |
| Name | string |
| Action (Button) | `onclick` - Use JavaScript |
| Action (Link) | `href` - Use a link |