mirror of
https://github.com/ChenQihan666/MyBlog-Next.git
synced 2026-08-14 11:29:33 +08:00
feat: enhance file name transformer with additional options (#555)
- Add v2 badge-style option as alternative to v1 tab-style - v2 features: border, rounded corners, positioned with CSS custom property - v1 features: tab-style with rounded top corners, muted background - Add hideDot option to control green dot indicator visibility - Include comprehensive JSDoc documentation with usage examples - Support both styling variants with configuration parameters
This commit is contained in:
@@ -1,5 +1,26 @@
|
||||
export const transformerFileName = () => ({
|
||||
/**
|
||||
* CustomShiki transformer that adds file name labels to code blocks.
|
||||
*
|
||||
* This transformer looks for the `file="filename"` meta attribute in code blocks
|
||||
* and creates a styled label showing the filename. It supports two different
|
||||
* styling options and can optionally hide the green dot indicator.
|
||||
*
|
||||
* @param {Object} options - Configuration options for the transformer
|
||||
* @param {string} [options.style="v2"] - The styling variant to use
|
||||
* - `"v1"`: Tab-style with rounded top corners, positioned at top-left
|
||||
* - `"v2"`: Badge-style with border, positioned at top-left with offset
|
||||
* @param {boolean} [options.hideDot=false] - Whether to hide the green dot indicator
|
||||
*/
|
||||
export const transformerFileName = ({
|
||||
style = "v2",
|
||||
hideDot = false,
|
||||
} = {}) => ({
|
||||
pre(node) {
|
||||
// Add CSS custom property to the node
|
||||
const fileNameOffset = style === "v1" ? "0.75rem" : "-0.75rem";
|
||||
node.properties.style =
|
||||
(node.properties.style || "") + `--file-name-offset: ${fileNameOffset};`;
|
||||
|
||||
const raw = this.options.meta?.__raw?.split(" ");
|
||||
|
||||
if (!raw) return;
|
||||
@@ -15,15 +36,25 @@ export const transformerFileName = () => ({
|
||||
|
||||
if (!file) return;
|
||||
|
||||
// Add additional margin to code block
|
||||
this.addClassToHast(
|
||||
node,
|
||||
`mt-8 ${style === "v1" ? "rounded-tl-none" : ""}`
|
||||
);
|
||||
|
||||
// Add file name to code block
|
||||
node.children.push({
|
||||
type: "element",
|
||||
tagName: "span",
|
||||
properties: {
|
||||
class: [
|
||||
"px-2 py-1",
|
||||
"absolute left-0 -top-6",
|
||||
"rounded-t-md border border-b-0",
|
||||
"bg-muted/50 text-foreground text-xs font-medium leading-4",
|
||||
"absolute py-1 text-foreground text-xs font-medium leading-4",
|
||||
hideDot
|
||||
? "px-2"
|
||||
: "pl-4 pr-2 before:inline-block before:size-1 before:bg-green-500 before:rounded-full before:absolute before:top-[45%] before:left-2",
|
||||
style === "v1"
|
||||
? "left-0 -top-6 rounded-t-md border border-b-0 bg-muted/50"
|
||||
: "left-2 top-(--file-name-offset) border rounded-md bg-background",
|
||||
],
|
||||
},
|
||||
children: [
|
||||
@@ -33,7 +64,5 @@ export const transformerFileName = () => ({
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
this.addClassToHast(node, "mt-12 rounded-tl-none");
|
||||
},
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user