konstaui / konsta

Mobile UI components made with Tailwind CSS
https://konstaui.com
MIT License
3.52k stars 131 forks source link

Default font change steps are incorrect #97

Closed erangac closed 1 year ago

erangac commented 1 year ago

Check that this is really a bug

Reproduction link

.

Bug description

Configuration is not correct to change default font. Refer document link https://konstaui.com/react/fonts

There aren't properties called ios & material. The given configuration will generate an error

Cannot read properties of undefined (reading 'material')

The currently in the document are below.

const konstaConfig = require('konsta/config');

module.exports = konstaConfig({
  theme: {
    fontFamily: {
      ios: 'my-ios-font',
      material: 'my-material-font',
    }
  }
  ...
});

Expected Behavior

No response

Actual Behavior

No response

Konsta UI version

0.11.1

Platform/Target and Browser Versions

macOs / Chrome Version 107.0.5304.110 (Official Build) (arm64)

Validations

Would you like to open a PR for this bug?

github-actions[bot] commented 1 year ago

Hello @erangac. Please provide a online reproduction by Stack Blitz or a minimal GitHub repository. You can fork this Stack Blitz to get start. Issues labeled by missing demo will be closed if no activities in 3 days.

jkhaui commented 1 year ago

I wouldn't say this is a bug, rather the example provided in the documentation is incorrect.

Custom font implementation should extend the existing Konsta tailwind config like this:

module.exports = konstaConfig({
  theme: {
    extend: {
      fontFamily: {
        ios: 'my-ios-font',
        material: 'my-material-font',
      }
    }
  }
  ...
});

instead of replacing it, like:

module.exports = konstaConfig({
  theme: {
    fontFamily: {
      ios: 'my-ios-font',
      material: 'my-material-font',
    }
  }
  ...
});