This documentation is for a release that is no longer maintained
See documentation for the latest supported version.8.3. Developer Hub インスタンスのサイドバーメニュー項目のカスタマイズ
Red Hat Developer Hub のサイドバーメニューは、設定可能な 2 つの主要部分で設定されます。
- 動的プラグインメニュー項目
- 設定とアクティブなプラグインは、サイドバーメニューの一部を動的に定義します。
- メインメニュー項目
サイドバーのコアナビゲーション構造は static です。
- 動的プラグインメニュー項目: これらの項目はメインメニューの下に表示され、インストールされているプラグインに基づいてカスタマイズできます。メインメニュー項目セクションは動的であり、設定やインストールされているプラグインに基づいて変更できます。
手順
次の手順に従って、メインメニュー項目をカスタマイズします。
-
app-config.yamlファイルを開きます。 -
メインメニュー項目の順序と親子関係をカスタマイズするには、
dynamicPlugins.frontend.default.main-menu-items.menuItemsフィールドを使用します。 -
動的プラグインのメニュー項目の場合は、
dynamicPlugins.frontend.<package_name>.menuItemsフィールドを使用します。
-
app-config.yaml ファイルの例
dynamicPlugins:
frontend:
default.main-menu-items:
menuItems:
default.home:
title: Home
icon: home
priority: 100
default.my-group:
title: My Group
icon: group
priority: 90
default.catalog:
title: Catalog
icon: category
to: catalog
priority: 80
default.apis:
title: APIs
icon: extension
to: api-docs
priority: 70
default.learning-path:
title: Learning Paths
icon: school,
to: learning-paths
priority: 60
default.create:
title: Create
icon: add
to: create
priority: 50
dynamicPlugins:
frontend:
default.main-menu-items:
menuItems:
default.home:
title: Home
icon: home
priority: 100
default.my-group:
title: My Group
icon: group
priority: 90
default.catalog:
title: Catalog
icon: category
to: catalog
priority: 80
default.apis:
title: APIs
icon: extension
to: api-docs
priority: 70
default.learning-path:
title: Learning Paths
icon: school,
to: learning-paths
priority: 60
default.create:
title: Create
icon: add
to: create
priority: 50
手順
動的プラグインメニュー項目を設定するには、< plugin_name > プラグインの
menuItemsセクションをapp-config.yamlファイルに更新します。以下に例を示します。dynamicPlugins: frontend: _<plugin_name>_: menuItems: <menu_item_name>: icon: # home | group | category | extension | school | _<my_icon>_ title: _<plugin_page_title>_ priority: 10 parent: favoritesdynamicPlugins: frontend: _<plugin_name>_:1 menuItems: <menu_item_name>:2 icon: # home | group | category | extension | school | _<my_icon>_3 title: _<plugin_page_title>_4 priority: 105 parent: favorites6 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- &
lt;plugin_name> : プラグイン名を入力します。この名前は、package.jsonファイルのscalprum.nameキーと同じです。 - 2
<menu_item_name>: スタンドアロンメニュー項目または親メニュー項目のいずれかのメインサイドバーナビゲーションに一意の名前を入力します。このフィールドでプラグインメニュー項目を指定した場合、メニュー項目の名前は、dynamicRoutesの対応するパスで使用される名前と一致する必要があります。たとえば、dynamicRoutesがpath: /my-pluginを定義した場合は、menu_item_nameをmy-pluginとして定義する必要があります。- 3
アイコン: (オプション)アイコン名を入力します。次のアイコンのいずれかを使用できます。-
ホーム、グループ、カテゴリー、拡張子、学校などのデフォルトのアイコン。デフォルトのアイコンを使用するには、アイコンを(" ")空の文字列として設定します。 - カスタムアイコン。< my_icon> は カスタムアイコンの名前を指定します。
-
icon: <svg width="20px" height="20px" viewBox="0 0 512" xmlns="http://www.w3.org/2000/svg" fill="#⚙ff">…</svg> などの SVG アイコン -
アイコンなどの HTML イメージ: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png
-
- 4
title: (任意)メニュー項目のタイトルを入力します。menuItem.textの下にあるdynamicRoutes設定でタイトルがすでに指定されている場合はこれを省略します。サイドバーからタイトルを非表示にするには、タイトルを空の文字列(" ")に設定します。- 5
優先度: (任意)サイドバーにメニュー項目が表示される順序を設定します。デフォルトの優先度は 0 で、項目はリストの一番下に配置されます。優先度の値が高いほど、その項目はサイドバー内の上の方に表示されます。このフィールドは、セクションごとに定義できます。- 6
parent: (任意)現在の項目が入れ子になっている親メニュー項目を入力します。このフィールドを使用する場合は、有効なプラグインのmenuItems設定の他の場所の親メニュー項目を定義する必要があります。このフィールドは、セクションごとに定義できます。
menuItemsの設定例dynamicPlugins: frontend: _<package_name>_: dynamicRoutes: - path: /my-plugin module: CustomModule importName: FooPluginPage menuItem: icon: fooIcon text: Foo Plugin Page menuItems: my-plugin: priority: 10 parent: favorites favorites: icon: favorite title: Favorites priority: 100dynamicPlugins: frontend: _<package_name>_: dynamicRoutes: - path: /my-plugin module: CustomModule importName: FooPluginPage menuItem: icon: fooIcon text: Foo Plugin Page menuItems: my-plugin:1 priority: 102 parent: favorites3 favorites:4 icon: favorite5 title: Favorites6 priority: 1007 Copy to Clipboard Copied! Toggle word wrap Toggle overflow メインのメニュー項目を変更したり、カスタムのメニュー項目を追加するには、
app-config.yamlファイルのdefault.main-menu-items>menuItemsセクションにセクションを追加します。default.接頭辞を使用して、キーをメインメニュー項目として識別します。dynamicPlugins: frontend: default.main-menu-items: menuItems: default._<menu_group_parent_item_name>_: icon: # home | group | category | extension | school | _<my_icon>_ title: _<menu_group_parent_title>_ priority: 10 default._<menu_item_name>_: parent: _<menu_group_parent_item_name>_ icon: # home | group | category | extension | school | _<my_icon>_ title: _<my_menu_title>_ to: _<path_to_the_menu_target_page>_ priority: 100dynamicPlugins: frontend: default.main-menu-items: menuItems: default._<menu_group_parent_item_name>_:1 icon: # home | group | category | extension | school | _<my_icon>_2 title: _<menu_group_parent_title>_3 priority: 104 default._<menu_item_name>_:5 parent: _<menu_group_parent_item_name>_6 icon: # home | group | category | extension | school | _<my_icon>_7 title: _<my_menu_title>_8 to: _<path_to_the_menu_target_page>_9 priority: 10010 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
デフォルト。<menu_group_parent_item_name> : (オプション)メニュー項目の親項目名を入力し、静的なメインメニュー項目を設定します。デフォルト。<menu_item_name> に親値が設定されていない場合、このフィールドは必要ありません。- 2
アイコン: メニューアイコンを入力します。親メニュー項目に必要です。- 3
タイトル: メニューグループのタイトルを入力します。親メニュー項目に必要です。- 4
priority: (オプション)メニューレベルでこのメニュー項目の順序を入力します。- 5
- Default
.<menu_item_name>: デフォルト値を上書きするメニュー項目名を入力します。メインのメニュー項目を特定するには、default.接頭辞を追加します。 - 6
parent: (任意)このアイテムの親メニュー項目を入力します。<menu_item_name> がメニュー項目の子として指定されている場合は必須です。- 7
アイコン: (オプション)メニューアイコンを入力します。デフォルトのアイコンを使用するには、アイコンを(" "")空の文字列として設定します。- 8
title: (任意)メニューグループのタイトルを入力します。新しいカスタムメインメニュー項目を追加する場合にのみ必要です。サイドバーからデフォルトのメインのメニュー項目のタイトルを非表示にするには、タイトルを空の文字列(" ")に設定します。- 9
- : (オプション)メニュー項目の移動先のパスを入力します。
設定されていない場合は、デフォルトでホームページに設定されます。 - 10
priority: (オプション)メニューレベルでこのメニュー項目の順序を入力します。
mainItemsの設定例default.main-menu-items: menuItems: default.catalog: icon: category title: My Catalog priority: 5 default.learning-path: title: '' default.parentlist: title: Overview icon: bookmarks default.home: parent: default.parentlist default.references: title: References icon: school to: /referencesdefault.main-menu-items: menuItems: default.catalog: icon: category1 title: My Catalog priority: 5 default.learning-path: title: ''2 default.parentlist:3 title: Overview icon: bookmarks default.home: parent: default.parentlist4 default.references: title: References5 icon: school6 to: /references7 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
アイコン: カタログのアイコンのデフォルトメニュー項目を変更するかどうかを指定します。- 2
title: 空の文字列" "を指定して、デフォルトのサイドバーから学習パスを非表示にします。- 3
default.parentlist: 親メニュー項目を導入します。- 4
parent:default.parentlistの親メニュー項目の下にあるホームメニューです。- 5
title:default.referencesの名前を指定します。- 6
アイコン:学校のアイコンを表示します。- 7
- :
default.referencesを/referencesページにリダイレクトします。