blocks

package
v0.0.0-...-9b3e9a9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 4, 2024 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

This is an example blocklet that doesn't have much sense. Use it as a template.

Index

Constants

View Source 
const (
	// Networking state is unknown. This indicates a daemon error that makes it
	// unable to reasonably assess the state. In such event the applications
	// are expected to assume Internet connectivity might be present and not
	// disable controls that require network access. The graphical shells may
	// hide the network accessibility indicator altogether since no meaningful
	// status indication can be provided.
	NM_STATE_UNKNOWN nmState = 0
	// Networking is not enabled, the system is being suspended or resumed from
	// suspend.
	NM_STATE_ASLEEP = 10
	// There is no active network connection. The graphical shell should
	// indicate no network connectivity and the applications should not attempt
	// to access the network.
	NM_STATE_DISCONNECTED = 20
	// Network connections are being cleaned up. The applications should tear
	// down their network sessions.
	NM_STATE_DISCONNECTING = 30
	// A network connection is being started The graphical shell should
	// indicate the network is being connected while the applications should
	// still make no attempts to connect the network.
	NM_STATE_CONNECTING = 40
	// There is only local IPv4 and/or IPv6 connectivity, but no default route
	// to access the Internet. The graphical shell should indicate no network
	// connectivity.
	NM_STATE_CONNECTED_LOCAL = 50
	// There is only site-wide IPv4 and/or IPv6 connectivity. This means a
	// default route is available, but the Internet connectivity check (see
	// "Connectivity" property) did not succeed. The graphical shell should
	// indicate limited network connectivity.
	NM_STATE_CONNECTED_SITE = 60
	// There is global IPv4 and/or IPv6 Internet connectivity This means the
	// Internet connectivity check succeeded, the graphical shell should
	// indicate full network connectivity.
	NM_STATE_CONNECTED_GLOBAL = 70
)
View Source 
const (
	// the state of the connection is unknown
	NM_ACTIVE_CONNECTION_STATE_UNKNOWN nmActiveConnectionState = 0
	// a network connection is being prepared
	NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1
	// there is a connection to the network
	NM_ACTIVE_CONNECTION_STATE_ACTIVATED = 2
	// the network connection is being torn down and cleaned up
	NM_ACTIVE_CONNECTION_STATE_DEACTIVATING = 3
	// the network connection is disconnected and will be removed
	NM_ACTIVE_CONNECTION_STATE_DEACTIVATED = 4
)
View Source 
const (
	// unknown device
	NM_DEVICE_TYPE_UNKNOWN nmDeviceType = 0
	// generic support for unrecognized device types
	NM_DEVICE_TYPE_GENERIC = 14
	// a wired ethernet device
	NM_DEVICE_TYPE_ETHERNET = 1
	// an 802.11 Wi-Fi device
	NM_DEVICE_TYPE_WIFI = 2
	// not used
	NM_DEVICE_TYPE_UNUSED1 = 3
	// not used
	NM_DEVICE_TYPE_UNUSED2 = 4
	// a Bluetooth device supporting PAN or DUN access protocols
	NM_DEVICE_TYPE_BT = 5
	// an OLPC XO mesh networking device
	NM_DEVICE_TYPE_OLPC_MESH = 6
	// an 802.16e Mobile WiMAX broadband device
	NM_DEVICE_TYPE_WIMAX = 7
	// a modem supporting analog telephone, CDMA/EVDO, GSM/UMTS, or LTE network
	// access protocols
	NM_DEVICE_TYPE_MODEM = 8
	// an IP-over-InfiniBand device
	NM_DEVICE_TYPE_INFINIBAND = 9
	// a bond master interface
	NM_DEVICE_TYPE_BOND = 10
	// an 802.1Q VLAN interface
	NM_DEVICE_TYPE_VLAN = 11
	// ADSL modem
	NM_DEVICE_TYPE_ADSL = 12
	// a bridge master interface
	NM_DEVICE_TYPE_BRIDGE = 13
	// a team master interface
	NM_DEVICE_TYPE_TEAM = 15
	// a TUN or TAP interface
	NM_DEVICE_TYPE_TUN = 16
	// a IP tunnel interface
	NM_DEVICE_TYPE_IP_TUNNEL = 17
	// a MACVLAN interface
	NM_DEVICE_TYPE_MACVLAN = 18
	// a VXLAN interface
	NM_DEVICE_TYPE_VXLAN = 19
	// a VETH interface
	NM_DEVICE_TYPE_VETH = 20
	// a MACsec interface
	NM_DEVICE_TYPE_MACSEC = 21
	// a dummy interface
	NM_DEVICE_TYPE_DUMMY = 22
	// a PPP interface
	NM_DEVICE_TYPE_PPP = 23
	// a Open vSwitch interface
	NM_DEVICE_TYPE_OVS_INTERFACE = 24
	// a Open vSwitch port
	NM_DEVICE_TYPE_OVS_PORT = 25
	// a Open vSwitch bridge
	NM_DEVICE_TYPE_OVS_BRIDGE = 26
	// a IEEE 802.15.4 (WPAN) MAC Layer Device
	NM_DEVICE_TYPE_WPAN = 27
	// 6LoWPAN interface
	NM_DEVICE_TYPE_6LOWPAN = 28
	// a WireGuard interface
	NM_DEVICE_TYPE_WIREGUARD = 29
	// an 802.11 Wi-Fi P2P device. Since: 1.16.
	NM_DEVICE_TYPE_WIFI_P2P = 30
	// A VRF (Virtual Routing and Forwarding) interface. Since: 1.24.
	NM_DEVICE_TYPE_VRF = 31
)
View Source 
const (
	// the device's state is unknown
	NM_DEVICE_STATE_UNKNOWN nmDeviceState = 0
	// the device is recognized, but not managed by NetworkManager
	NM_DEVICE_STATE_UNMANAGED = 10
	// the device is managed by NetworkManager, but is not available for use.
	// Reasons may include the wireless switched off, missing firmware, no
	// ethernet carrier, missing supplicant or modem manager, etc.
	NM_DEVICE_STATE_UNAVAILABLE = 20
	// the device can be activated, but is currently idle and not connected to
	// a network.
	NM_DEVICE_STATE_DISCONNECTED = 30
	// the device is preparing the connection to the network. This may include
	// operations like changing the MAC address, setting physical link
	// properties, and anything else required to connect to the requested
	// network.
	NM_DEVICE_STATE_PREPARE = 40
	// the device is connecting to the requested network. This may include
	// operations like associating with the Wi-Fi AP, dialing the modem,
	// connecting to the remote Bluetooth device, etc.
	NM_DEVICE_STATE_CONFIG = 50
	// the device requires more information to continue connecting to the
	// requested network. This includes secrets like WiFi passphrases, login
	// passwords, PIN codes, etc.
	NM_DEVICE_STATE_NEED_AUTH = 60
	// the device is requesting IPv4 and/or IPv6 addresses and routing
	// information from the network.
	NM_DEVICE_STATE_IP_CONFIG = 70
	// the device is checking whether further action is required for the
	// requested network connection. This may include checking whether only
	// local network access is available, whether a captive portal is blocking
	// access to the Internet, etc.
	NM_DEVICE_STATE_IP_CHECK = 80
	// the device is waiting for a secondary connection (like a VPN) which must
	// activated before the device can be activated
	NM_DEVICE_STATE_SECONDARIES = 90
	// the device has a network connection, either local or global.
	NM_DEVICE_STATE_ACTIVATED = 100
	// a disconnection from the current network connection was requested, and
	// the device is cleaning up resources used for that connection. The
	// network connection may still be valid.
	NM_DEVICE_STATE_DEACTIVATING = 110
	// the device failed to connect to the requested network and is cleaning up
	// the connection request
	NM_DEVICE_STATE_FAILED = 120
)

Variables

This section is empty.

Functions

func NewBatteryBlock 

func NewBatteryBlock() I3barBlocklet

func NewBluezBlock 

func NewBluezBlock() I3barBlocklet

func NewClickcountBlock 

func NewClickcountBlock() I3barBlocklet

func NewDbusBlock 

func NewDbusBlock() I3barBlocklet

func NewLuaBlock 

func NewLuaBlock() I3barBlocklet

func NewMprisBlock 

func NewMprisBlock() I3barBlocklet

func NewPulseBlock 

func NewPulseBlock() I3barBlocklet

func NewShellBlock 

func NewShellBlock() I3barBlocklet

func NewStaticBlock 

func NewStaticBlock(text string) I3barBlocklet

func NewSwayLayoutBlock 

func NewSwayLayoutBlock() I3barBlocklet

func NewSwayWindow 

func NewSwayWindow() I3barBlocklet

func NewTimeBlock 

func NewTimeBlock() I3barBlocklet

Types

type BatteryBlock 

type BatteryBlock struct {
	BatteryBlockConfig
	// contains filtered or unexported fields
}

func (*BatteryBlock) GetConfig 

func (t *BatteryBlock) GetConfig() interface{}

func (*BatteryBlock) Render 

func (t *BatteryBlock) Render(cfg *AppConfig) []I3barBlock

func (*BatteryBlock) Run 

func (t *BatteryBlock) Run(ch UpdateChan, ctx context.Context)

type BatteryBlockConfig 

type BatteryBlockConfig struct {
	Format *ConfigFormat `yaml:"format"`
	// Device name. See above.
	UpowerDevice string            `yaml:"upower_device"`
	StateIcons   map[string]string `yaml:"state_icons"`
	LevelIcons   []string          `yaml:"level_icons"`
	UrgentLevel  *int              `yaml:"urgent_level"`
}

Display battery charge level. Requires UPower to work over DBus `upower_device` can be obtained via DBus using the following command: ```bash 

$ busctl --json=pretty --system call org.freedesktop.UPower \
  /org/freedesktop/UPower org.freedesktop.UPower \
  EnumerateDevices \
  | jq -r '.data[0] | map(match("[^/]+$").string)[]'`

``` If empty, the program will try to detect battery device.

type BluezBlock 

type BluezBlock struct {
	BluezBlockConfig
	// contains filtered or unexported fields
}

func (*BluezBlock) GetConfig 

func (t *BluezBlock) GetConfig() interface{}

func (*BluezBlock) Render 

func (b *BluezBlock) Render(cfg *AppConfig) []I3barBlock

func (*BluezBlock) Run 

func (t *BluezBlock) Run(ch UpdateChan, ctx context.Context)

type BluezBlockConfig 

type BluezBlockConfig struct {
	BaseBlockletConfig `yaml:",inline"`
	// Mac address of the device
	Device string        `yaml:"mac"`
	Format *ConfigFormat `yaml:"format"`
	// Device format
	DeviceFormat *ConfigFormat     `yaml:"device_format"`
	Icons        map[string]string `yaml:"icons"`
	ExcludeMac   []string          `yaml:"exclude"`
}

Displays connected bluetooth devices

type Clickcount 

type Clickcount struct {
	ClickcountConfig
	// contains filtered or unexported fields
}

func (*Clickcount) GetConfig 

func (c *Clickcount) GetConfig() interface{}

func (*Clickcount) OnEvent 

func (t *Clickcount) OnEvent(e *I3barClickEvent, ctx context.Context)

func (*Clickcount) Render 

func (t *Clickcount) Render(cfg *AppConfig) []I3barBlock

func (*Clickcount) Run 

func (c *Clickcount) Run(ch UpdateChan, ctx context.Context)

type ClickcountConfig 

type ClickcountConfig struct {
	Format *ConfigFormat `yaml:"format"`
}

type DbusBlock 

type DbusBlock struct {
	DbusConfig
	// contains filtered or unexported fields
}

func (*DbusBlock) GetConfig 

func (b *DbusBlock) GetConfig() interface{}

func (*DbusBlock) Render 

func (b *DbusBlock) Render(cfg *AppConfig) []I3barBlock

func (*DbusBlock) Run 

func (b *DbusBlock) Run(ch UpdateChan, ctx context.Context)

type DbusConfig 

type DbusConfig struct {
	ObjectPath  string `yaml:"object_path"`
	InitialText string `yaml:"initial_text"`
}

type LuaBlock 

type LuaBlock struct {
	LuaConfig
}

func (*LuaBlock) GetConfig 

func (b *LuaBlock) GetConfig() interface{}

func (*LuaBlock) Render 

func (b *LuaBlock) Render(cfg *AppConfig) []I3barBlock

func (*LuaBlock) Run 

func (b *LuaBlock) Run(ch UpdateChan, ctx context.Context)

type LuaConfig 

type LuaConfig struct {
	Script string `yaml:"script"`
}

type MprisBlock 

type MprisBlock struct {
	MprisBlockConfig
	// contains filtered or unexported fields
}

func (*MprisBlock) GetConfig 

func (s *MprisBlock) GetConfig() interface{}

func (*MprisBlock) OnEvent 

func (t *MprisBlock) OnEvent(e *I3barClickEvent, ctx context.Context)

func (*MprisBlock) Render 

func (b *MprisBlock) Render(cfg *AppConfig) []I3barBlock

func (*MprisBlock) Run 

func (b *MprisBlock) Run(ch UpdateChan, ctx context.Context)

type MprisBlockConfig 

type MprisBlockConfig struct {
	Icons        map[playbackStatus]string `yaml:"icons"`
	PlayerFormat *ConfigFormat             `yaml:"player_format"`
	Separator    string                    `yaml:"separator"`
}

type MprisPlayer 

type MprisPlayer struct {
	// contains filtered or unexported fields
}

type NetworkManagerBlock 

type NetworkManagerBlock struct {
	NetworkManagerBlockConfig
	// contains filtered or unexported fields
}

func (*NetworkManagerBlock) GetConfig 

func (t *NetworkManagerBlock) GetConfig() interface{}

func (*NetworkManagerBlock) Render 

func (b *NetworkManagerBlock) Render(cfg *AppConfig) []I3barBlock

func (*NetworkManagerBlock) Run 

func (t *NetworkManagerBlock) Run(ch UpdateChan, ctx context.Context)

type NetworkManagerBlockConfig 

type NetworkManagerBlockConfig struct {
	BaseBlockletConfig `yaml:",inline"`
	Format             *ConfigFormat          `yaml:"format"`
	AccessPointFormat  *ConfigFormat          `yaml:"ap_format"`
	PrimaryOnly        bool                   `yaml:"primary_only"`
	Icons              map[string]interface{} `yaml:"icons"`
}

type NmAccessPoint 

type NmAccessPoint struct {
	// contains filtered or unexported fields
}

type NmActiveConnection 

type NmActiveConnection struct {
	// contains filtered or unexported fields
}

type NmDevice 

type NmDevice struct {
	// contains filtered or unexported fields
}

type NmIp4Config 

type NmIp4Config struct {
	// contains filtered or unexported fields
}

type PulseBlock 

type PulseBlock struct {
	PulseConfig
	// contains filtered or unexported fields
}

func (*PulseBlock) GetConfig 

func (c *PulseBlock) GetConfig() interface{}

func (*PulseBlock) OnEvent 

func (t *PulseBlock) OnEvent(e *I3barClickEvent, ctx context.Context)

func (*PulseBlock) Render 

func (t *PulseBlock) Render(cfg *AppConfig) []I3barBlock

func (*PulseBlock) Run 

func (c *PulseBlock) Run(ch UpdateChan, ctx context.Context)

type PulseConfig 

type PulseConfig struct {
	BaseBlockletConfig `yaml:",inline"`
	Node               string           `yaml:"node"`
	Format             *ConfigFormat    `yaml:"format"`
	Icons              PulseIconsConfig `yaml:"icons"`
}

type PulseIconsConfig 

type PulseIconsConfig struct {
	Devices     map[string]string `yaml:"devices"`
	SinkMuted   string            `yaml:"sink_muted"`
	SourceMuted string            `yaml:"source_muted"`
}

type ShellBlock 

type ShellBlock struct {
	ShellBlockConfig
	// contains filtered or unexported fields
}

func (*ShellBlock) GetConfig 

func (s *ShellBlock) GetConfig() any

func (*ShellBlock) OnEvent 

func (t *ShellBlock) OnEvent(e *I3barClickEvent, ctx context.Context)

func (*ShellBlock) Render 

func (t *ShellBlock) Render(cfg *AppConfig) []I3barBlock

func (*ShellBlock) Run 

func (b *ShellBlock) Run(ch UpdateChan, ctx context.Context)

type ShellBlockConfig 

type ShellBlockConfig struct {
	// Shell command to run
	Command string `yaml:"command"`
	// Shell command to run when a blocklet is clicked
	OnClickCommand *string         `yaml:"on_click"`
	Interval       *ConfigInterval `yaml:"interval"`
	RestartOnExit  bool            `yaml:"restart_on_exit"`
	// Treat command's output as json instead of plain text
	Json bool `yaml:"json"`
}

Displays output for a shell script It has three modes:

  • run script every N seconds, wait for it to exit
  • run script once, read lines from it's stdout and update the blocklet per each line
  • run script in a loop as soon as it exits

type StaticBlock 

type StaticBlock struct {
	// contains filtered or unexported fields
}

func (*StaticBlock) Render 

func (b *StaticBlock) Render(cfg *AppConfig) []I3barBlock

func (*StaticBlock) Run 

func (t *StaticBlock) Run(ch UpdateChan, ctx context.Context)

func (*StaticBlock) SetColor 

func (t *StaticBlock) SetColor(color *ConfigColor)

type SwayLayout 

type SwayLayout struct {
	SwayLayoutConfig
	// contains filtered or unexported fields
}

func (*SwayLayout) GetConfig 

func (s *SwayLayout) GetConfig() interface{}

func (*SwayLayout) OnEvent 

func (s *SwayLayout) OnEvent(e *I3barClickEvent, ctx context.Context)

func (*SwayLayout) Render 

func (s *SwayLayout) Render(cfg *AppConfig) []I3barBlock

func (*SwayLayout) Run 

func (s *SwayLayout) Run(ch UpdateChan, ctx context.Context)

type SwayLayoutConfig 

type SwayLayoutConfig struct {
	Format *ConfigFormat `yaml:"format"`
	Input  *string       `yaml:"input"`
}

Displays current keyboard layout. Uses sway's IPC API for retrieving the info (i.e. won't work with i3wm)

type SwayWindow 

type SwayWindow struct {
	// contains filtered or unexported fields
}

func (*SwayWindow) Render 

func (t *SwayWindow) Render(cfg *AppConfig) []I3barBlock

func (*SwayWindow) Run 

func (t *SwayWindow) Run(ch UpdateChan, ctx context.Context)

type SwayWindowConfig 

type SwayWindowConfig struct {
}

type TimeBlock 

type TimeBlock struct {
	TimeBlockConfig
}

func (*TimeBlock) GetConfig 

func (t *TimeBlock) GetConfig() interface{}

func (*TimeBlock) Render 

func (t *TimeBlock) Render(cfg *AppConfig) []I3barBlock

func (*TimeBlock) Run 

func (t *TimeBlock) Run(ch UpdateChan, ctx context.Context)

type TimeBlockConfig 

type TimeBlockConfig struct {
	Format   *ConfigFormat   `yaml:"format"`
	Layout   string          `yaml:"layout"`
	Interval *ConfigInterval `yaml:"interval"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.