cssinjs/jss

TS error using a function to customise defaults with the default unit plugin

Open

#1444 opened on Jan 20, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (7,000 stars) (434 forks)batch import
help wantedtypescript

Description

Expected behavior: Use the 'jss-plugin-default-unit' to override default units for numeric values in combination with TypeScript.

Describe the bug: The plugin itself doesn't appear to have any issues but I am receiving TypeScript related errors in my IDE when using a function to define an option for the plugin.

const options = {
    width: val => `${val / 2}px`
}
jss.use(defaultUnit(options));

Source: https://cssinjs.org/jss-plugin-default-unit/?v=v10.5.0#customizing-defaults

I'm not sure if the following is the cause but the two definitions of the Options type do not seem to match:

Codesandbox: N/A

Versions:

  • react-jss: 10.5.0
  • typescript: 4.0.3
  • OS: Linux

Contributor guide

Tech stack
typescriptjavascriptcss
Domain
frontenddeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript typesJSS plugin system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the two files: packages/jss plugin default unit/src/index.js and packages/jss plugin default unit/src/index.d.ts. The Options type in the .d.ts may need to accept a function type for default values. Check the JssStyle type and ensure consistency. No existing PRs or comments provide additional guidance.