Badge

Similar to a Button, the Badge component uses the same syntax as a hyperlink, but is prefixed with a !badge identifier.

[!badge Badge](badge.md)

[Normal link](badge.md)

With the Badge component, the link is optional and can be omitted.

[!badge Badge]

Variant

// Text only (default Primary variant)
[!badge My Badge]

// Text with variant
[!badge variant="base" text="My Badge"]

// With link and variant
[!badge variant="primary" text="My Badge"](https://example.com/)

Corners

[!badge text="Default"]
[!badge corners="square" text="Square"]
[!badge corners="pill" text="Button Pill"]

Size

[!badge size="m" text="Medium"]

Target

Sets the target attribute of the badge and specifies which window or tab to open the link into.

Neko

[!badge target="blank" text="Neko"](https://example.com/)

If no target is configured, the link will open in the current tab.

The target can be set to any value, although blank is common and will open the link in a new tab. Neko will automatically transform the value blank into _blank which is the actual value required by the browser to indicate that a hyperlink should be opened in a new tab.

There are several other values that may be prefixed with an _ character, including self, parent, and top. The following table demonstrates some common scenarios and naming convention used by Neko to normalize the target values.

See also the links.target configuration.

Icon and Emoji

UIcons

UIcons can be used as an icon by settiing the icon property with the name of the UIcon.

[!badge variant="info" icon="user" text="User" margin="0 8 0 0"]
[!badge variant="primary" icon="paper-plane" iconAlign="right" text="Send"]

User Send

Emoji

Emoji :shortcodes: can be used for the icon. Please see Mojee for a full list of supported Emoji shortcodes.

[!badge variant="light" icon=":heart:" text="Like"]
[!badge variant="info" icon=":rocket:" iconAlign="right" text="Rocket"]

❤️Like Rocket🚀

Image file

Any image file can be used as the icon.

[!badge icon="../static/neko-icon.svg"]

icon="../static/neko-icon.svg"

SVG image

The icon can also be set with an inline <svg> element.

[!badge icon="<svg width=&quot;24&quot; height=&quot;24&quot;><path fill-rule=&quot;evenodd&quot; d=&quot;M12 16.5a4.5 4.5 0 100-9 4.5 4.5 0 000 9zm0 1.5a6 6 0 100-12 6 6 0 000 12z&quot;></path></svg>" text="Visit website"](badge.md)

Visit website

Theme variables

Neko gives you full control over the look and feel of your badge components through customizable [theme variables].

You can override any of theme variable in your neko.yml configuration file using the theme.base and theme.dark settings.

For example, to change the primary badge color and text color for all instances of the primary badge within your project, add the following to your project's neko.yml file:

theme:
  base:
    # Revise the primary variant base color
    # across all components within the project
    # primary: "#209fb5"

    # Or, adjust badge only theme variables
    badge-primary: "#209fb5"
    badge-primary-text: "#eff1f5"

To learn more about theme variables and how they work across Neko, check out the Themes Guide, the [Theme Variables] documentation, and theme Project settings.