Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.17 KB

README.md

File metadata and controls

41 lines (26 loc) · 2.17 KB

BlueprintJS for Kotlin/React

Github Build GitHub license

Kotlin wrappers for Palantir's BlueprintJS React components library.

Usage

RBuilder extensions

For each blueprintjs component, some RBuilder extension functions are defined with the prefix bp (e.g. RBuilder.bpButton()). This makes it more convenient to use in kotlin-react.

Icons module

The icons module wrapper is not mandatory to use icons, because you can use simple strings to refer to icons. Only the @blueprintjs/icons module is necessary to actually bring the icons, but not the wrapper.

The wrapper module only contains the IconNames object declaring all icon name constants. It allows to refer to icons in a type-safe way to avoid mistakes.

Versioning

The version of each wrapper module is composed of the wrapped module version followed by a dash - and the version of this wrapper library.

For example: 3.42.0-1 is the version 1 of the module wrapping @blueprintjs/core version 3.42.0

core version
icons version

Setup

These blueprintjs wrappers are published to Maven Central. You can add them to your Gradle dependencies the usual way (you don't need to add transitive BlueprintJS NPM dependencies anymore):

implementation("org.hildan.blueprintjs:kotlin-blueprintjs-core:$blueprintCoreWrapperVersion")
implementation("org.hildan.blueprintjs:kotlin-blueprintjs-icons:$blueprintIconsWrapperVersion")