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.

Constructors

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

Properties

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
props → List<Object>
The List of props (properties) which will be used to determine whether two Equatables are equal.
read-only
romanization Romanization
The romanization map used for converting to and from Japanese and Latin characters. [...]
final
upcaseKatakana → bool
Indicates whether to convert katakana to uppercase using KanaKit.toRomaji. [...]
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
stringify → bool
If the value is true, the toString method will be overrided to print the equatable props.
read-only, inherited

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 non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited

Constants

defaultConfig → const KanaKitConfig
The default config for KanaKit. [...]
const KanaKitConfig(passRomaji: false, passKanji: true, upcaseKatakana: false)