Skip to content

This tool is designed to help you produce standardised, consistent icons for Qlik Sense and Qlik Cloud.

License

Notifications You must be signed in to change notification settings

withdave/qlik-icon-generator

Repository files navigation

Qlik Icon Generator (qs-icon-generator)

Note This "mashup" can only be deployed onto Qlik Sense client-managed. If you wish to use it with Qlik Cloud, you can use a version hosted here or host it yourself.

This script helps you to produce standard, consistent icons for use with Qlik Sense Enterprise client-managed and Qlik Cloud. It uses some simple background images and text which help make it visually easier for users to access their frequent apps.

An example using the provided templates for sheet icons: Default configuration, with a green logo generated

Installation

To install:

  • Qlik Sense client-managed: This has been packaged as an extension, so just upload it under extensions in the QMC, then navigate to /extensions/qs-icon-generator/index.html to create some icons.
  • Qlik Cloud: This extension will not run on Qlik Cloud. You will need to self-host, or you can use a hosted version of this build here.

The default deployment looks like: Default configuration, with a green logo generated

Configuration

Configuration is via the src/qs-icon-generator/config.json file, and supporting background images in the src/qs-icon-generator/backgrounds/ directory.

Several templates are included by default:

  • modern_qlik_cloud_grey - uses a square grey background image with white app name text, sized for the card and list views in the Qlik Cloud hub - approx 3x the size of qlik_cloud_* versions but looks much more clear in the hub
  • modern_qlik_cloud_green - uses a square green background image with white app name text, sized for the card and list views in the Qlik Cloud hub - approx 3x the size of qlik_cloud_* versions but looks much more clear in the hub
  • modern_qlik_cloud_white - uses a square white background image with grey app name text, sized for the card and list views in the Qlik Cloud hub - approx 3x the size of qlik_cloud_* versions but looks much more clear in the hub
  • modern_qlik_sheet_green - uses a green background with white text - approx 3x the size of qlik_sheet_* versions but looks much more clear in the app
  • modern_qlik_sheet_grey - uses a grey background with white text - approx 3x the size of qlik_sheet_* versions but looks much more clear in the app
  • modern_qlik_sheet_white - uses a white background with green text - approx 3x the size of qlik_sheet_* versions but looks much more clear in the app
  • qlik_cloud_green - uses a square green background image with white app name text, sized for the card and list views in the Qlik Cloud hub
  • qlik_cloud_grey - uses a square grey background image with white app name text, sized for the card and list views in the Qlik Cloud hub
  • qlik_cloud_white - uses a white background image with grey app name text, sized for the card and list views in the Qlik Cloud hub
  • qlik_green - uses a partially green background image with white app name text
  • qlik_white - uses a fully white background image with dark text
  • qlik_sheet_green - uses a green background with white text
  • qlik_sheet_grey - uses a grey background with white text
  • qlik_sheet_white - uses a white background with green text

If you wish to change the background of an existing or new template, start from one of the examples, or review the following:

  • Suitable format - ideally PNG file, but can be JPG, JPEG or GIF
  • Correct size for app icons, which differs based on your product version
    • Qlik Sense client-managed: 164x108 pixels, which is acceptable for both the hub and in-app aspect ratios
    • Qlik Cloud: 288x180, which is acceptable for the different aspect rations found in the hub home, hub catalog (both grid and list) in-app aspect ratios
    • If you have both products, use the Qlik Cloud sizing
  • Correct size for sheet icons: 140x90 pixels (except when in edit mode, when this is different)

About

This tool is designed to help you produce standardised, consistent icons for Qlik Sense and Qlik Cloud.

Resources

License

Stars

Watchers

Forks

Packages

No packages published