Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/SnipMeDev/KodeView

Kotlin Multiplatform syntax highlighting views
https://github.com/SnipMeDev/KodeView

highlighting kmm kmm-library kotlin-android kotlin-library kotlin-multiplatform kotlin-native syntax-highlighting

Last synced: 3 months ago
JSON representation

Kotlin Multiplatform syntax highlighting views

Host: GitHub
URL: https://github.com/SnipMeDev/KodeView
Owner: SnipMeDev
License: apache-2.0
Created: 2023-06-25T17:29:03.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-02-27T06:38:00.000Z (4 months ago)
Last Synced: 2024-02-27T07:57:46.434Z (4 months ago)
Topics: highlighting, kmm, kmm-library, kotlin-android, kotlin-library, kotlin-multiplatform, kotlin-native, syntax-highlighting
Language: Kotlin
Homepage:
Size: 820 KB
Stars: 41
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-list - SnipMeDev/KodeView - Kotlin Multiplatform syntax highlighting views (Kotlin)
kmp-awesome - KodeView

README

        ![kodeview_banner_opaque](https://github.com/SnipMeDev/KodeView/assets/8405055/59c6a2af-1b32-4a02-998f-ecae2296363a)

[![Maven Central](https://img.shields.io/maven-central/v/dev.snipme/kodeview)](https://mvnrepository.com/artifact/dev.snipme)

[![Kotlin](https://img.shields.io/badge/kotlin-1.9.21-blue.svg?logo=kotlin)](http://kotlinlang.org)

[![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)

# KodeView

Kotlin Compose Multiplatform components for syntax highlighting based on

[Highlights](https://github.com/SnipMeDev/Highlights) library.

## Preview



## Installation ⬇️

```shell

repositories {

    mavenCentral()

}

```

```shell

implementation("dev.snipme:kodeview:0.8.0")

```

## Features ✨

- CodeTextView

- CodeEditText

- Code component analysis (Keyword, comment, etc.)

- Multiple syntax languages (Java, Swift, Kotlin, C, ...)

- Themes

- Text bolding (emphasis)

- Written in pure Kotlin, so available for many platforms 📱 💻 🖥️

## Support ☕

Kotlin Multiplatform is a fresh environment and developing for it is neither fast nor easy 🥲

If you feel that any of our project has saved you a time or effort, then consider supporting us via:  

[🧋 Buy Me A Coffee](https://bmc.link/SnipMeDev)

## Components 🧩

### CodeTextView

Basic component that takes instance of Highlights and applies coloring on a text.

```kotlin

@Composable

fun MyApp() {

    val highlights = remember {

        mutableStateOf(

            Highlights

                .Builder(code = "public static void main(String[] args) {}")

                .build()

        )

    }

   MaterialTheme {

      Column {

        CodeTextView(highlights = highlights.value)

      }

   }

}

```

### CodeEditText

With this component, you can update your code via `onValueChange` callback.  

The Highlights library is ready for incremental updates, so change values anytime.  

The view bases on `TextField()`, and all it's fields are available for customization.  

```kotlin

@Composable

fun MyApp() {

    val highlights = remember {

        mutableStateOf(

            Highlights

                .Builder(code = "public static void main(String[] args) {}")

                .build()

        )

    }

   MaterialTheme {

      Column {

          CodeEditText(

              highlights = highlights.value,

              onValueChange = { textValue ->

                  highlights.value = highlights.value.getBuilder()

                      .code(textValue)

                      .build()

              },

              // Customize view's style

              colors = TextFieldDefaults.textFieldColors(),

          )

      }

   }

}

```

## Run examples 🏎️

Not all examples can be executed from command line, so recommended way is to use pre-created configurations:



## TODO 🚧

- [X] CodeEditText

## Contribution 💻

Any form of support is very welcomed. 

Bugs, problems and new feature requests should be placed in the `Issues` tab with proper labeling.

New feature can be also submitted via `Pull Requests`. 

Then make sure:

- CHANGELOG and README have been updated

- New code matches library's vision and code style

License 🖋️

=======

    Copyright 2023 Tomasz Kądziołka.

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.