frontend-plugin-api: document that icons should be 24x24

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/frontend-plugin-api/src/icons/types.ts

@@ -40,6 +40,10 @@ export type IconComponent = ComponentType<{
 /**
  * The type used for icon elements throughout Backstage.
  *
+ * @remarks
+ *
+ * Icons should be exactly 24x24 pixels in size.
+ *
  * @public
  */
 export type IconElement = JSX.Element | null;

packages/frontend-plugin-api/src/wiring/coreExtensionData.ts

@@ -22,6 +22,7 @@ import { createExtensionDataRef } from './createExtensionDataRef';
 /** @public */
 export const coreExtensionData = {
   title: createExtensionDataRef<string>().with({ id: 'core.title' }),
+  /** An icon element for the extension. Should be exactly 24x24 pixels. */
   icon: createExtensionDataRef<IconElement>().with({ id: 'core.icon' }),
   reactElement: createExtensionDataRef<JSX.Element>().with({
     id: 'core.reactElement',