Design System Utilities @ 0.1.1-alpha.0
GitHub
by Maddi Mathon
Preparing search index...
Tokens
Typography
Font
familyGenerator
Function familyGenerator
familyGenerator
<
T_Slug
extends
string
>
(
slug
:
T_Slug
,
name
:
string
,
familyOpts
?:
Omit
<
Partial
<
Tokens_Typography
.
Font
.
Family
<
T_Slug
>
>
,
"path"
|
"style"
|
"weight"
,
>
&
{
includeLocalSrc
?:
boolean
}
,
weightOpts
?:
{
"100"
?:
FileOptions
;
"200"
?:
FileOptions
;
"300"
?:
FileOptions
;
"400"
?:
FileOptions
;
"500"
?:
FileOptions
;
"600"
?:
FileOptions
;
"700"
?:
FileOptions
;
"800"
?:
FileOptions
;
"900"
?:
FileOptions
;
}
,
)
:
Tokens_Typography
.
Font
.
Family
<
T_Slug
>
&
{
weights
:
Required
<
Tokens_Typography
.
Font
.
Family
<
T_Slug
>
[
"weights"
]
>
;
}
Helps to generate all the weights for a font family.
Type Parameters
T_Slug
extends
string
Parameters
slug
:
T_Slug
name
:
string
familyOpts
:
Omit
<
Partial
<
Tokens_Typography
.
Font
.
Family
<
T_Slug
>
>
,
"path"
|
"style"
|
"weight"
,
>
&
{
includeLocalSrc
?:
boolean
}
= {}
weightOpts
:
{
"100"
?:
FileOptions
;
"200"
?:
FileOptions
;
"300"
?:
FileOptions
;
"400"
?:
FileOptions
;
"500"
?:
FileOptions
;
"600"
?:
FileOptions
;
"700"
?:
FileOptions
;
"800"
?:
FileOptions
;
"900"
?:
FileOptions
;
}
= {}
Returns
Tokens_Typography
.
Font
.
Family
<
T_Slug
>
&
{
weights
:
Required
<
Tokens_Typography
.
Font
.
Family
<
T_Slug
>
[
"weights"
]
>
;
}
Since
0.1.0-alpha
Settings
Member Visibility
Alpha
Beta
External
Inherited
Private
Protected
Theme
OS
Light
Dark
GitHub
by Maddi Mathon
Design System Utilities @ 0.1.1-alpha.0
Loading...
Helps to generate all the weights for a font family.