KanaKitConfig class

A configuration class with flags that influence certain parts of KanaKit.

To use a default config and customize it, use defaultConfig and replace fields using copyWith.

Annotations
  • @immutable

Constructors

KanaKitConfig({required bool passRomaji, required bool passKanji, required bool upcaseKatakana})
A configuration class with flags that influence certain parts of KanaKit.
const

Properties

hashCode int
The hash code for this object.
no setteroverride
passKanji bool
Indicates whether to ignore kanji when checking KanaKit.isMixed.
final
passRomaji bool
Indicates whether to skip romaji characters when converting text using KanaKit.toKatakana or KanaKit.toHiragana.
final
romanization Romanization
The romanization map used for converting to and from Japanese and Latin characters.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
upcaseKatakana bool
Indicates whether to convert katakana to uppercase using KanaKit.toRomaji.
final

Methods

copyWith({bool? passRomaji, bool? passKanji, bool? upcaseKatakana}) KanaKitConfig
Creates a copy of this object that replaces the provided fields.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(covariant KanaKitConfig other) bool
The equality operator.
override

Constants

defaultConfig → const KanaKitConfig
The default config for KanaKit.