docs(composables/class): add example

bynaryDE · Nov 18, 2023 · 59358e2 · 59358e2
1 parent 87944d5
commit 59358e2
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/libs/composables/class/src/provide-base-class.ts b/libs/composables/class/src/provide-base-class.ts
@@ -7,10 +7,24 @@ export const BASE_CLASS = new InjectionToken<string>('@bynary/composables/class.
 
 /**
  * Provide a base CSS class that should be applied to a host.
+ * The base class can be injected using the {@link BASE_CLASS} token.
+ * This token will be used by {@link useModifier} and {@link useModifierGroup} to generate modifier classes.
  *
  * @see useModifier
  * @see useModifierGroup
  *
+ * @example
+ * ```ts
+ * @Component({
+ *    selector: 'my-component',
+ *    providers: [
+ *        provideBaseClass('my-component')
+ *    ]
+ * })
+ * class MyComponent {
+ *     baseClass = inject(BASE_CLASS); // 'my-component'
+ * }
+ *
  * @param baseClass - The base class to provide.
  */
 export const provideBaseClass = (baseClass: string) => ({