Sharing Links

Share a design (or a style) using a single link.

Sharing Links

Favycons can load icon settings from a single iconconfig URL query parameter.

This is used in two places:

  • Share a full design: use iconconfig directly.
  • Share a style only: use the app’s “Share Style” action.

Share a Full Design

Use the iconconfig parameter to load a specific design:

https://app.favycons.com/?iconconfig=<base64url-json>

The value is a base64url-encoded JSON object with the full icon configuration.

After loading a valid iconconfig, the app strips it from the URL automatically (to keep your address bar clean). Your design is still persisted in your local session.

iconconfig Format

  • Parameter name: iconconfig
  • Value: base64url(utf8(JSON.stringify(iconSettings)))
  • JSON shape: IconSettings (includes schemaVersion)

iconconfig uses the same schema validation as the export pipeline, so invalid configs will not crash the editor.

Share a Style (From the App)

Use the “Share Style” button in the header.

Notes:

  • The link contains an iconconfig too, but it’s generated from your current style.
  • The shared link uses a predictable icon motif so recipients see the style clearly.

Generating an iconconfig value

If you have a full IconSettings object, you can generate a URL-safe iconconfig value like this:

function encodeIconConfig(iconSettings) {
  const json = JSON.stringify(iconSettings);
  const bytes = new TextEncoder().encode(json);

  let binary = '';
  for (const b of bytes) binary += String.fromCharCode(b);

  const base64 = btoa(binary);
  return base64
    .replace(/\+/g, '-')
    .replace(/\//g, '_')
    .replace(/=+$/g, '');
}

const iconconfig = encodeIconConfig(iconSettings);
const url = `https://app.favycons.com/?iconconfig=${iconconfig}`;

Unsupported Legacy Params

Legacy per-field parameters (e.g. icon=..., bgColor=...) are not supported anymore. If they are present without iconconfig, Favycons loads defaults and shows a warning.

Reserved app-level params

Some parameters are reserved for app-level flows (for example Stripe redirects). Currently:

  • upgrade

Reserved parameters do not affect icon settings.

Error Handling

If iconconfig is invalid (decode/JSON/schema), Favycons:

  • Shows a warning banner
  • Loads the editor with default settings

Notes

  • iconconfig is URL-safe (base64url). You generally do not need extra URL encoding.
  • Very large configurations can hit practical URL length limits in some apps/services.