---
id: os
title: OS
sidebar_label: OS
---

## What

Display OS specific info - defaults to Icon.

## Sample Configuration

import Config from '@site/src/components/Config.js';

<Config data={{
  "type": "os",
  "style": "plain",
  "foreground": "#26C6DA",
  "background": "#546E7A",
  "template": " {{ if .WSL }}WSL at {{ end }}{{.Icon}}\uE0B1",
  "properties": {
    "macos": "mac"
  }
}}/>

## Properties

| Name                  | Type      | Default  | Description                                         |
| --------------------- | :-------: | :------: | --------------------------------------------------- |
| `macos`               | `string`  | `\uF179` | the string to use for macOS                         |
| `linux`               | `string`  | `\uF17C` | the icon to use for Linux                           |
| `windows`             | `string`  | `\uE62A` | the icon to use for Windows                         |
| `display_distro_name` | `boolean` | `false`  | display the distro name or icon (for WSL and Linux) |
| `alma`                | `string`  | `\uF31D` | the icon to use for Alma                            |
| `alpine`              | `string`  | `\uF300` | the icon to use for Alpine                          |
| `aosc`                | `string`  | `\uF301` | the icon to use for Aosc                            |
| `arch`                | `string`  | `\uF303` | the icon to use for Arch                            |
| `centos`              | `string`  | `\uF304` | the icon to use for Centos                          |
| `coreos`              | `string`  | `\uF305` | the icon to use for Coreos                          |
| `debian`              | `string`  | `\uF306` | the icon to use for Debian                          |
| `devuan`              | `string`  | `\uF307` | the icon to use for Devuan                          |
| `raspbian`            | `string`  | `\uF315` | the icon to use for Raspbian                        |
| `elementary`          | `string`  | `\uF309` | the icon to use for Elementary                      |
| `fedora`              | `string`  | `\uF30a` | the icon to use for Fedora                          |
| `gentoo`              | `string`  | `\uF30d` | the icon to use for Gentoo                          |
| `mageia`              | `string`  | `\uF310` | the icon to use for Mageia                          |
| `manjaro`             | `string`  | `\uF312` | the icon to use for Manjaro                         |
| `mint`                | `string`  | `\uF30e` | the icon to use for Mint                            |
| `nixos`               | `string`  | `\uF313` | the icon to use for Nixos                           |
| `opensuse`            | `string`  | `\uF314` | the icon to use for Opensuse                        |
| `redhat`              | `string`  | `\uF316` | the icon to use for Redhat                          |
| `rocky`               | `string`  | `\uF32B` | the icon to use for Rocky                           |
| `sabayon`             | `string`  | `\uF317` | the icon to use for Sabayon                         |
| `slackware`           | `string`  | `\uF319` | the icon to use for Slackware                       |
| `ubuntu`              | `string`  | `\uF31b` | the icon to use for Ubuntu                          |

## Template ([info][templates])

:::note default template

```template
{{ if .WSL }}WSL at {{ end }}{{.Icon}}
```

:::

### Properties

| Name    | Type     | Description |
| ------- | -------- | ----------- |
| `.Icon` | `string` | the OS icon |

[templates]: /docs/configuration/templates
