From 67c37dd0182b97fdbff8d917ca31761547ece136 Mon Sep 17 00:00:00 2001
From: William Martin <contact@willmartian.com>
Date: Wed, 6 Nov 2024 15:16:24 -0500
Subject: [PATCH] clarify global config service

---
 libs/components/src/index.ts                             | 2 +-
 ...{bit-settings.service.ts => design-system.service.ts} | 9 +++++++--
 2 files changed, 8 insertions(+), 3 deletions(-)
 rename libs/components/src/shared/{bit-settings.service.ts => design-system.service.ts} (60%)

diff --git a/libs/components/src/index.ts b/libs/components/src/index.ts
index b63c09a84d5..526b2001b0f 100644
--- a/libs/components/src/index.ts
+++ b/libs/components/src/index.ts
@@ -30,7 +30,7 @@ export * from "./radio-button";
 export * from "./search";
 export * from "./section";
 export * from "./select";
-export * from "./shared/bit-settings.service";
+export * from "./shared/design-system.service";
 export * from "./table";
 export * from "./tabs";
 export * from "./toast";
diff --git a/libs/components/src/shared/bit-settings.service.ts b/libs/components/src/shared/design-system.service.ts
similarity index 60%
rename from libs/components/src/shared/bit-settings.service.ts
rename to libs/components/src/shared/design-system.service.ts
index c02c137bc35..8ac9b011846 100644
--- a/libs/components/src/shared/bit-settings.service.ts
+++ b/libs/components/src/shared/design-system.service.ts
@@ -1,8 +1,13 @@
 import { effect, Injectable, signal, WritableSignal } from "@angular/core";
 
-/** Global settings for the Bitwarden Design System */
+/** Global config for the Bitwarden Design System */
 @Injectable({ providedIn: "root" })
-export class BitSettingsService {
+export class DesignSystemService {
+  /**
+   * When true, enables "compact mode".
+   *
+   * Component authors can hook into compact mode with the `bit-compact:` Tailwind variant.
+   **/
   compactMode: WritableSignal<boolean> = signal(false);
 
   constructor() {