feat: provide edito button to jump directly to the item in a repo
closes #115
This commit is contained in:
committed by
Bastian
parent
95fefb55ff
commit
7e65a17e7c
@@ -65,5 +65,9 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"dateFormat": "MMMM YYYY"
|
"dateFormat": "MMMM YYYY",
|
||||||
|
"editLink": {
|
||||||
|
"radarLink": "https://github.com/AOEpeople/techradar/edit/main/radar",
|
||||||
|
"title": "Edit"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
16
src/components/EditButton/EditButton.tsx
Normal file
16
src/components/EditButton/EditButton.tsx
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import React from "react";
|
||||||
|
import { Item } from "../../model";
|
||||||
|
import "./editButton.scss";
|
||||||
|
|
||||||
|
type EditButtonProps = {
|
||||||
|
baseUrl: string;
|
||||||
|
item: Item & { release? : string }
|
||||||
|
title?: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function EditButton({baseUrl, item, title}: React.PropsWithChildren<EditButtonProps>) {
|
||||||
|
const href = `${baseUrl}/${item.release}/${item.name}.md`;
|
||||||
|
return (
|
||||||
|
<a className="icon-link" href={href} target="_blank" rel="noopener noreferrer">{title || 'Edit'}</a>
|
||||||
|
);
|
||||||
|
}
|
||||||
2
src/components/EditButton/editButton.scss
Normal file
2
src/components/EditButton/editButton.scss
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
.edit-button {
|
||||||
|
}
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
import React from "react";
|
import React from "react";
|
||||||
import Badge from "../Badge/Badge";
|
import Badge from "../Badge/Badge";
|
||||||
|
import EditButton from "../EditButton/EditButton";
|
||||||
import ItemList from "../ItemList/ItemList";
|
import ItemList from "../ItemList/ItemList";
|
||||||
import Link from "../Link/Link";
|
import Link from "../Link/Link";
|
||||||
import FooterEnd from "../FooterEnd/FooterEnd";
|
import FooterEnd from "../FooterEnd/FooterEnd";
|
||||||
@@ -47,6 +48,7 @@ const PageItem: React.FC<Props> = ({ pageName, items, config, leaving, onLeave }
|
|||||||
});
|
});
|
||||||
|
|
||||||
const item = getItem(pageName, items);
|
const item = getItem(pageName, items);
|
||||||
|
const editButton = config.editLink ? <EditButton baseUrl={config.editLink.radarLink} item={item} title={config.editLink.title}/> : ''
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
@@ -99,10 +101,11 @@ const PageItem: React.FC<Props> = ({ pageName, items, config, leaving, onLeave }
|
|||||||
>
|
>
|
||||||
<div className="item-page__header">
|
<div className="item-page__header">
|
||||||
<div className="split">
|
<div className="split">
|
||||||
<div className="split__left">
|
<div className="split__left hero-headline__wrapper">
|
||||||
<h1 className="hero-headline hero-headline--inverse">
|
<h1 className="hero-headline hero-headline--inverse">
|
||||||
{item.title}
|
{item.title}
|
||||||
</h1>
|
</h1>
|
||||||
|
{editButton}
|
||||||
</div>
|
</div>
|
||||||
<div className="split__right">
|
<div className="split__right">
|
||||||
<Badge big type={item.ring}>
|
<Badge big type={item.ring}>
|
||||||
|
|||||||
@@ -50,6 +50,12 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.hero-headline__wrapper {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
.mobile-item-page {
|
.mobile-item-page {
|
||||||
background: #fff;
|
background: #fff;
|
||||||
margin: 0 -15px;
|
margin: 0 -15px;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import React from "react";
|
|
||||||
import Badge from "../Badge/Badge";
|
import Badge from "../Badge/Badge";
|
||||||
|
import EditButton from "../EditButton/EditButton";
|
||||||
import ItemList from "../ItemList/ItemList";
|
import ItemList from "../ItemList/ItemList";
|
||||||
import Link from "../Link/Link";
|
import Link from "../Link/Link";
|
||||||
import Fadeable from "../Fadeable/Fadeable";
|
import Fadeable from "../Fadeable/Fadeable";
|
||||||
@@ -40,6 +40,7 @@ export default function PageItemMobile({
|
|||||||
|
|
||||||
const item = getItem(pageName, items);
|
const item = getItem(pageName, items);
|
||||||
const itemsInRing = getItemsInRing(pageName, items);
|
const itemsInRing = getItemsInRing(pageName, items);
|
||||||
|
const editButton = config.editLink ? <EditButton baseUrl={config.editLink.radarLink} item={item} title={config.editLink.title}/> : ''
|
||||||
return (
|
return (
|
||||||
<Fadeable leaving={leaving} onLeave={onLeave}>
|
<Fadeable leaving={leaving} onLeave={onLeave}>
|
||||||
<SetTitle title={item.title} />
|
<SetTitle title={item.title} />
|
||||||
@@ -53,6 +54,7 @@ export default function PageItemMobile({
|
|||||||
<h1 className="hero-headline hero-headline--inverse">
|
<h1 className="hero-headline hero-headline--inverse">
|
||||||
{item.title}
|
{item.title}
|
||||||
</h1>
|
</h1>
|
||||||
|
{editButton}
|
||||||
</div>
|
</div>
|
||||||
<div className="split__right">
|
<div className="split__right">
|
||||||
<Badge big type={item.ring}>
|
<Badge big type={item.ring}>
|
||||||
|
|||||||
@@ -13,6 +13,10 @@ export interface ConfigData {
|
|||||||
};
|
};
|
||||||
homepageContent: HomepageOption;
|
homepageContent: HomepageOption;
|
||||||
dateFormat?: string;
|
dateFormat?: string;
|
||||||
|
editLink?: {
|
||||||
|
radarLink: string,
|
||||||
|
title?: string
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export const radarName =
|
export const radarName =
|
||||||
|
|||||||
Reference in New Issue
Block a user