@unocss/preset-typography 0.55.1 → 0.55.3

package/dist/index.cjs

@@ -28,8 +28,11 @@ const DEFAULT = {
     "font-style": "italic",
     "border-left": ".25em solid var(--un-prose-borders)"
   },
+  // taking 16px as a base, we scale h1, h2, h3, and h4 like
+  // 16 (base) > 18 (h4) > 22 (h3) > 28 (h2) > 36 (h1)
   "h1": {
     "margin": "1rem 0",
+    // h1 is always at the top of the page, so only margin 1 * root font size
     "font-size": "2.25em"
   },
   "h2": {
@@ -246,6 +249,7 @@ function presetTypography(options) {
             "--un-prose-code": colorObject[900] ?? baseColor,
             "--un-prose-borders": colorObject[200] ?? baseColor,
             "--un-prose-bg-soft": colorObject[100] ?? baseColor,
+            // invert colors (dark mode)
             "--un-prose-invert-body": colorObject[200] ?? baseColor,
             "--un-prose-invert-headings": colorObject[100] ?? baseColor,
             "--un-prose-invert-links": colorObject[100] ?? baseColor,
@@ -290,5 +294,5 @@ function presetTypography(options) {
   };
 }
 
-exports["default"] = presetTypography;
+exports.default = presetTypography;
 exports.presetTypography = presetTypography;

package/dist/index.d.cts

@@ -0,0 +1,65 @@
+import { CSSObject, Preset } from '@unocss/core';
+import { Theme } from '@unocss/preset-mini';
+
+/** @public */
+interface TypographyCompatibilityOptions {
+  noColonWhere?: boolean
+  noColonIs?: boolean
+  noColonNot?: boolean
+}
+
+/**
+ * @public
+ */
+interface TypographyOptions {
+    /**
+     * The selector name to use the typographic utilities.
+     * To undo the styles to the elements, use it like
+     * `not-${selectorName}` which is by default `not-prose`.
+     *
+     * Note: `not` utility is only available in class mode.
+     *
+     * @defaultValue `prose`
+     */
+    selectorName?: string;
+    /**
+     * Extend or override CSS selectors with CSS declaration block.
+     *
+     * @defaultValue undefined
+     */
+    cssExtend?: Record<string, CSSObject>;
+    /**
+     * Compatibility option. Notice that it will affect some features.
+     * For more instructions, see
+     * [README](https://github.com/unocss/unocss/tree/main/packages/preset-typography)
+     *
+     * @defaultValue undefined
+     */
+    compatibility?: TypographyCompatibilityOptions;
+    /**
+     * @deprecated use `selectorName` instead. It will be removed in 1.0.
+     */
+    className?: string;
+}
+/**
+ * UnoCSS Preset for Typography
+ *
+ * ```js
+ * // uno.config.ts
+ * import { presetAttributify, presetUno, defineConfig, presetTypography } from 'unocss'
+ *
+ * export default defineConfig({
+ *   presets: [
+ *     presetAttributify(), // required if using attributify mode
+ *     presetUno(), // required
+ *     presetTypography()
+ *   ]
+ * })
+ * ```
+ *
+ * @returns typography preset
+ * @public
+ */
+declare function presetTypography(options?: TypographyOptions): Preset<Theme>;
+
+export { type TypographyOptions, presetTypography as default, presetTypography };

package/dist/index.d.mts

@@ -0,0 +1,65 @@
+import { CSSObject, Preset } from '@unocss/core';
+import { Theme } from '@unocss/preset-mini';
+
+/** @public */
+interface TypographyCompatibilityOptions {
+  noColonWhere?: boolean
+  noColonIs?: boolean
+  noColonNot?: boolean
+}
+
+/**
+ * @public
+ */
+interface TypographyOptions {
+    /**
+     * The selector name to use the typographic utilities.
+     * To undo the styles to the elements, use it like
+     * `not-${selectorName}` which is by default `not-prose`.
+     *
+     * Note: `not` utility is only available in class mode.
+     *
+     * @defaultValue `prose`
+     */
+    selectorName?: string;
+    /**
+     * Extend or override CSS selectors with CSS declaration block.
+     *
+     * @defaultValue undefined
+     */
+    cssExtend?: Record<string, CSSObject>;
+    /**
+     * Compatibility option. Notice that it will affect some features.
+     * For more instructions, see
+     * [README](https://github.com/unocss/unocss/tree/main/packages/preset-typography)
+     *
+     * @defaultValue undefined
+     */
+    compatibility?: TypographyCompatibilityOptions;
+    /**
+     * @deprecated use `selectorName` instead. It will be removed in 1.0.
+     */
+    className?: string;
+}
+/**
+ * UnoCSS Preset for Typography
+ *
+ * ```js
+ * // uno.config.ts
+ * import { presetAttributify, presetUno, defineConfig, presetTypography } from 'unocss'
+ *
+ * export default defineConfig({
+ *   presets: [
+ *     presetAttributify(), // required if using attributify mode
+ *     presetUno(), // required
+ *     presetTypography()
+ *   ]
+ * })
+ * ```
+ *
+ * @returns typography preset
+ * @public
+ */
+declare function presetTypography(options?: TypographyOptions): Preset<Theme>;
+
+export { type TypographyOptions, presetTypography as default, presetTypography };

package/dist/index.d.ts

@@ -62,4 +62,4 @@ interface TypographyOptions {
  */
 declare function presetTypography(options?: TypographyOptions): Preset<Theme>;
 
-export { TypographyOptions, presetTypography as default, presetTypography };
+export { type TypographyOptions, presetTypography as default, presetTypography };

package/dist/index.mjs

@@ -24,8 +24,11 @@ const DEFAULT = {
     "font-style": "italic",
     "border-left": ".25em solid var(--un-prose-borders)"
   },
+  // taking 16px as a base, we scale h1, h2, h3, and h4 like
+  // 16 (base) > 18 (h4) > 22 (h3) > 28 (h2) > 36 (h1)
   "h1": {
     "margin": "1rem 0",
+    // h1 is always at the top of the page, so only margin 1 * root font size
     "font-size": "2.25em"
   },
   "h2": {
@@ -242,6 +245,7 @@ function presetTypography(options) {
             "--un-prose-code": colorObject[900] ?? baseColor,
             "--un-prose-borders": colorObject[200] ?? baseColor,
             "--un-prose-bg-soft": colorObject[100] ?? baseColor,
+            // invert colors (dark mode)
             "--un-prose-invert-body": colorObject[200] ?? baseColor,
             "--un-prose-invert-headings": colorObject[100] ?? baseColor,
             "--un-prose-invert-links": colorObject[100] ?? baseColor,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unocss/preset-typography",
-  "version": "0.55.1",
+  "version": "0.55.3",
   "description": "Typography preset for UnoCSS",
   "author": "Jeff Yang",
   "license": "MIT",
@@ -32,8 +32,8 @@
     "dist"
   ],
   "dependencies": {
-    "@unocss/core": "0.55.1",
-    "@unocss/preset-mini": "0.55.1"
+    "@unocss/core": "0.55.3",
+    "@unocss/preset-mini": "0.55.3"
   },
   "scripts": {
     "build": "unbuild",