doc: clarify that the default value of the defaultFontFamily is empty

thx · Jan 15, 2024 · 7cd8739 · 7cd8739 · vercel · Jan 15, 2024
1 parent 06dd2c0
commit 7cd8739
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -2,11 +2,11 @@
 
 export type ResvgRenderOptions = {
   font?: {
-    loadSystemFonts?: boolean // Default: true. if set to false, it will be faster.
+    loadSystemFonts?: boolean // Default: true, if set to false, it will be faster.
     fontFiles?: string[] // A list of local font file paths to load.
     fontDirs?: string[] // A list of local font directories to load.
     defaultFontSize?: number // Default: 12
-    defaultFontFamily?: string
+    defaultFontFamily?: string // Default: "", if `loadSystemFonts` is enabled, it will be set to the first font in the list of system fonts.
     serifFamily?: string
     sansSerifFamily?: string
     cursiveFamily?: string

diff --git a/src/options.rs b/src/options.rs
@@ -242,7 +242,7 @@ pub struct JsFontOptions {
     ///
     /// Will be used when no `font-family` attribute is set in the SVG.
     ///
-    /// Default: Times New Roman
+    /// Default: ""
     pub default_font_family: String,
 
     /// The default font size.