Rename static to image 🚚

danth · Nov 18, 2023 · 4ba0a07 · 4ba0a07
1 parent 3ddd609
commit 4ba0a07
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 27 deletions.
diff --git a/docs/settings.nix b/docs/settings.nix
@@ -3,7 +3,7 @@
 { pkgs, config, ... }:
 
 {
-  stylix.wallpaper = config.lib.stylix.make.static {
+  stylix.wallpaper = config.lib.stylix.make.image {
     image = pkgs.fetchurl {
       url = "https://picsum.photos/seed/stylix/1920/1080.jpg";
       sha256 = "tow7DBO+/tgkDDD8diif+0V/6aDzrYl02/J7SCA8RCU=";

diff --git a/docs/src/installation.md b/docs/src/installation.md
@@ -119,7 +119,7 @@ let
 in {
     imports = [ (import stylix).homeManagerModules.stylix ];
 
-    stylix.wallpaper = config.lib.stylix.make.static {
+    stylix.wallpaper = config.lib.stylix.make.image {
       image = ./wallpaper.jpg;
     };
 }

diff --git a/docs/src/tricks.md b/docs/src/tricks.md
@@ -16,7 +16,7 @@ let
   fillColor = "black"
 in
 {
-  stylix.wallpaper = config.lib.stylix.make.static {
+  stylix.wallpaper = config.lib.stylix.make.image {
     image = pkgs.runCommand "dimmed-background.png" { } ''
       ${pkgs.imagemagick}/bin/convert "${inputImage}" -brightness-contrast ${brightness},${contrast} -fill ${fillColor} $out
     '';

diff --git a/docs/src/wallpaper-support.md b/docs/src/wallpaper-support.md
@@ -1,15 +1,15 @@
 # Wallpaper support
 
-|              | Static | Slideshow | Animation | Video |
-|--------------|--------|-----------|-----------|-------|
-| bspwm        | ✔️      | ✔️         | ✔️         | ✔️     |
-| GNOME        | ✔️      | ✔️         | ❌         | ❌     |
-| GRUB         | ✔️      | ❌         | ❌         | ❌     |
-| herbstluftwm | ✔️      | ✔️         | ✔️         | ✔️     |
-| Hyprland     | ✔️      | ✔️         | ✔️         | ✔️     |
-| i3           | ✔️      | ✔️         | ✔️         | ✔️     |
-| KDE          | ✔️      | ❌         | ❌         | ❌     |
-| LightDM      | ✔️      | ❌         | ❌         | ❌     |
-| spectrwm     | ✔️      | ✔️         | ✔️         | ✔️     |
-| Sway         | ✔️      | ✔️         | ✔️         | ✔️     |
-| Xmonad       | ✔️      | ✔️         | ✔️         | ✔️     |
+|              | Image | Slideshow | Animation | Video |
+|--------------|-------|-----------|-----------|-------|
+| bspwm        | ✔️     | ✔️         | ✔️         | ✔️     |
+| GNOME        | ✔️     | ✔️         | ❌         | ❌     |
+| GRUB         | ✔️     | ❌         | ❌         | ❌     |
+| herbstluftwm | ✔️     | ✔️         | ✔️         | ✔️     |
+| Hyprland     | ✔️     | ✔️         | ✔️         | ✔️     |
+| i3           | ✔️     | ✔️         | ✔️         | ✔️     |
+| KDE          | ✔️     | ❌         | ❌         | ❌     |
+| LightDM      | ✔️     | ❌         | ❌         | ❌     |
+| spectrwm     | ✔️     | ✔️         | ✔️         | ✔️     |
+| Sway         | ✔️     | ✔️         | ✔️         | ✔️     |
+| Xmonad       | ✔️     | ✔️         | ✔️         | ✔️     |
diff --git a/lib/types.nix b/lib/types.nix
@@ -59,8 +59,8 @@ let
 
 in mergeModules [
   (objectModule {
-    name = "static";
-    description = "static wallpaper";
+    name = "image";
+    description = "image wallpaper";
     descriptionClass = "noun";
     constructor =
       { image, polarity ? "either" }:
@@ -112,7 +112,7 @@ in mergeModules [
   {
     types.wallpaper =
       with config.lib.stylix.types;
-      types.oneOf [ static slideshow animation video ];
+      types.oneOf [ image slideshow animation video ];
   }
 
   (let

diff --git a/stylix/darwin/etc.nix b/stylix/darwin/etc.nix
@@ -5,7 +5,7 @@ args:
   imports = [ (import ../palette.nix args) ];
 
   config.environment.etc = {
-    "stylix/wallpaper".source = if (config.lib.stylix.types.static.check config.stylix.wallpaper) then config.stylix.wallpaper.image
+    "stylix/wallpaper".source = if (config.lib.stylix.types.image.check config.stylix.wallpaper) then config.stylix.wallpaper.image
     else if (config.lib.stylix.types.animation.check config.stylix.wallpaper) then config.stylix.wallpaper.animation 
     else if (config.lib.stylix.types.video.check config.stylix.wallpaper) then config.stylix.wallpaper.video 
     else config.stylix.wallpaper.images;

diff --git a/stylix/hm/xdg.nix b/stylix/hm/xdg.nix
@@ -5,7 +5,7 @@ args:
   imports = [ (import ../palette.nix args) ];
 
   config.xdg.configFile = {
-    "stylix/wallpaper".source = if (config.lib.stylix.types.static.check config.stylix.wallpaper) then config.stylix.wallpaper.image
+    "stylix/wallpaper".source = if (config.lib.stylix.types.image.check config.stylix.wallpaper) then config.stylix.wallpaper.image
     else if (config.lib.stylix.types.animation.check config.stylix.wallpaper) then config.stylix.wallpaper.animation 
     else if (config.lib.stylix.types.video.check config.stylix.wallpaper) then config.stylix.wallpaper.video 
     else config.stylix.wallpaper.images;

diff --git a/stylix/nixos/etc.nix b/stylix/nixos/etc.nix
@@ -5,7 +5,7 @@ args:
   imports = [ (import ../palette.nix args) ];
 
   config.environment.etc = {
-    "stylix/wallpaper".source = if (config.lib.stylix.types.static.check config.stylix.wallpaper) then config.stylix.wallpaper.image
+    "stylix/wallpaper".source = if (config.lib.stylix.types.image.check config.stylix.wallpaper) then config.stylix.wallpaper.image
     else if (config.lib.stylix.types.animation.check config.stylix.wallpaper) then config.stylix.wallpaper.animation 
     else if (config.lib.stylix.types.video.check config.stylix.wallpaper) then config.stylix.wallpaper.video 
     else config.stylix.wallpaper.images;

diff --git a/stylix/palette.nix b/stylix/palette.nix
@@ -26,10 +26,10 @@ in {
         with values.stylix;
         mkIf (image != "_mkMergedOptionModule") (
           if polarity == "_mkMergedOptionModule"
-          then config.lib.stylix.make.static {
+          then config.lib.stylix.make.image {
             inherit image;
           }
-          else config.lib.stylix.make.static {
+          else config.lib.stylix.make.image {
             inherit image polarity;
           }
         ))) 
@@ -46,13 +46,13 @@ in {
         ```nix
         { config, ... }:
         {
-          stylix.wallpaper = config.lib.stylix.make.static {
+          stylix.wallpaper = config.lib.stylix.make.image {
             image = ./path/to/image.png;
           };
         }
         ```
 
-        Static wallpapers work everywhere.
+        Image wallpapers work everywhere.
         [This table](https://danth.github.io/stylix/wallpaper-support.html)
         shows which software supports the other wallpaper types.
 
@@ -101,7 +101,7 @@ in {
         ```nix
         { config, ... }:
         {
-          stylix.wallpaper = config.lib.stylix.make.static {
+          stylix.wallpaper = config.lib.stylix.make.image {
             image = ./night-sky.jpg;
             polarity = "dark";
           };