From 8d86dc66c0387e5772b034e5a278e506a946f29b Mon Sep 17 00:00:00 2001 From: Aya Tanikawa <15815271+ayatnkw@users.noreply.github.com> Date: Mon, 10 Jun 2024 10:51:50 +0200 Subject: [PATCH 1/3] update icon property description in base file reference for node buildling --- .../build/reference/node-base-files.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/integrations/creating-nodes/build/reference/node-base-files.md b/docs/integrations/creating-nodes/build/reference/node-base-files.md index 14b916323..92272cbdf 100644 --- a/docs/integrations/creating-nodes/build/reference/node-base-files.md +++ b/docs/integrations/creating-nodes/build/reference/node-base-files.md @@ -78,9 +78,23 @@ The internal name of the object. Used to reference it from other places in the n ### `icon` -_String_ | _Required_ +_String_ or _Object_ | _Optional_ -Starts with `file`. For example, `icon: 'file:exampleNodeIcon.svg'`. +Specifies an icon for a particular node. n8n recommends uploading your own image file. + +You can provide the icon as a string or as an object to handle different icons for light and dark modes. +If the icon works in both light and dark modes, use a string that starts with `file:`, indicating the path to the icon file. For example: + +``` +icon: 'file:exampleNodeIcon.svg' +``` +To provide different icons for light and dark modes, use an object with `light` and `dark` properties. For example: +``` +icon: { + light: 'file:exampleNodeIcon.svg', + dark: 'file:exampleNodeIcon.dark.svg' +} +``` --8<-- "_snippets/integrations/creating-nodes/node-icons.md" From 551971d10dc5405cd76d12b75ddfb30e31c44019 Mon Sep 17 00:00:00 2001 From: Aya Tanikawa <15815271+ayatnkw@users.noreply.github.com> Date: Mon, 10 Jun 2024 12:24:04 +0200 Subject: [PATCH 2/3] make icon property required --- .../creating-nodes/build/reference/node-base-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/creating-nodes/build/reference/node-base-files.md b/docs/integrations/creating-nodes/build/reference/node-base-files.md index 92272cbdf..3c26eef5f 100644 --- a/docs/integrations/creating-nodes/build/reference/node-base-files.md +++ b/docs/integrations/creating-nodes/build/reference/node-base-files.md @@ -78,7 +78,7 @@ The internal name of the object. Used to reference it from other places in the n ### `icon` -_String_ or _Object_ | _Optional_ +_String_ or _Object_ | _Required_ Specifies an icon for a particular node. n8n recommends uploading your own image file. From 3f561d8380029de5d920057d6ced74a22e7de47a Mon Sep 17 00:00:00 2001 From: Deborah Date: Tue, 11 Jun 2024 09:53:11 +0100 Subject: [PATCH 3/3] Update docs/integrations/creating-nodes/build/reference/node-base-files.md --- .../creating-nodes/build/reference/node-base-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/creating-nodes/build/reference/node-base-files.md b/docs/integrations/creating-nodes/build/reference/node-base-files.md index 3c26eef5f..cef9a58ac 100644 --- a/docs/integrations/creating-nodes/build/reference/node-base-files.md +++ b/docs/integrations/creating-nodes/build/reference/node-base-files.md @@ -82,7 +82,7 @@ _String_ or _Object_ | _Required_ Specifies an icon for a particular node. n8n recommends uploading your own image file. -You can provide the icon as a string or as an object to handle different icons for light and dark modes. +You can provide the icon file name as a string, or as an object to handle different icons for light and dark modes. If the icon works in both light and dark modes, use a string that starts with `file:`, indicating the path to the icon file. For example: ```