From 16961986da02c2dd508fe28e5830be569a9ea26f Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 30 Oct 2024 14:31:19 -0400 Subject: [PATCH] update docs --- libs/components/src/stories/compact-mode.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libs/components/src/stories/compact-mode.mdx b/libs/components/src/stories/compact-mode.mdx index ca7f8b3c214..0fba7cd2477 100644 --- a/libs/components/src/stories/compact-mode.mdx +++ b/libs/components/src/stories/compact-mode.mdx @@ -17,7 +17,7 @@ by removing the class. Alternatively ## Tailwind Component authors can hook into this setting with the `bit-compact` Tailwind variant. In the -following example, the paragraph's padding is removed when compact mode is enabled. +following example, the paragraph's padding is reduced when compact mode is enabled. ```html

Lorem impsum doggo dolor...

@@ -33,10 +33,10 @@ following example, the paragraph's padding is removed when compact mode is enabl

Lorem impsum doggo dolor...

-## Toggling compact mode +## Settings Service -Compact mode can be enabled by adding the `tw-bit-compact` class to an ancestor element and disabled -by removing the class. +To get/set compact mode in TypeScript, the `BitSettingsService` exposes a `compactMode` signal. +However, using the Tailwind variant should be preferred as it is more performant. ## Components that support compact mode