chore: reworking how to override the page component

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-08-07 11:33:26 +02:00
parent b7506f214e
commit b284ecb010
2 changed files with 62 additions and 12 deletions
@@ -0,0 +1,51 @@
/*
* Copyright 2024 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { IconComponent } from '@backstage/core-plugin-api';
import { RouteRef } from '../routing';
import { createExtensionBlueprint } from '../wiring';
import { createNavItemExtension } from './createNavItemExtension';
export const NavItemBlueprint = createExtensionBlueprint({
kind: 'nav-item',
attachTo: { id: 'app/nav', input: 'items' },
output: [createNavItemExtension.targetDataRef],
dataRefs: {
target: createNavItemExtension.targetDataRef,
},
factory: (
{
icon,
routeRef,
}: {
title: string;
icon: IconComponent;
routeRef: RouteRef<undefined>;
},
{ config },
) => [
createNavItemExtension.targetDataRef({
title: config.title,
icon,
routeRef,
}),
],
config: {
schema: ({ title }) => ({
title: z => z.string().default(title),
}),
},
});
@@ -107,24 +107,23 @@ describe('PageBlueprint', () => {
it('should allow defining additional inputs to the extension', async () => {
const myPage = PageBlueprint.make({
name: 'test-page',
params: {
loader: async ({ inputs }) => {
return (
<div data-testid="test">
{inputs.cards.map(c => c.get(coreExtensionData.reactElement))}
</div>
);
},
defaultPath: '/test',
routeRef: mockRouteRef,
},
/* todo(blam): need to fix the typescript here, as inputs is not the right type, wont let me merge without specifying parent opts */
inputs: {
cards: createExtensionInput([coreExtensionData.reactElement], {
optional: false,
singleton: false,
}),
},
factory(originalFactory, { inputs }) {
return originalFactory({
loader: async () => (
<div data-testid="test">
{inputs.cards.map(c => c.get(coreExtensionData.reactElement))}
</div>
),
defaultPath: '/test',
routeRef: mockRouteRef,
});
},
});
const CardBlueprint = createExtensionBlueprint({