compose-highlight/dev.hossain.highlight.ui

Package-level declarations

Types

data class CodeBlockStyle(val shape: Shape = SyntaxHighlightedCodeDefaults.shape, val padding: PaddingValues = SyntaxHighlightedCodeDefaults.padding, val headerPadding: PaddingValues = SyntaxHighlightedCodeDefaults.headerPadding, val lineNumberColor: Color = Color.Unspecified, val lineNumberWidth: Dp = SyntaxHighlightedCodeDefaults.lineNumberWidth, val copyButtonSize: Dp = SyntaxHighlightedCodeDefaults.copyButtonSize, val textStyle: TextStyle = SyntaxHighlightedCodeDefaults.codeTextStyle, val fallbackBackgroundColor: Color = SyntaxHighlightedCodeDefaults.fallbackBackgroundColor, val fallbackTextColor: Color = SyntaxHighlightedCodeDefaults.fallbackTextColor)

Visual style configuration for SyntaxHighlightedCode.

ExperimentalHighlightApi

@RequiresOptIn(message = "This API is part of the experimental compose-highlight surface and may change or be removed in future releases without a deprecation cycle.", level = RequiresOptIn.Level.ERROR)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

annotation class ExperimentalHighlightApi

Marks an API as experimental within the compose-highlight library.

SyntaxHighlightedCodeDefaults

object SyntaxHighlightedCodeDefaults

Default values and helper composables used by SyntaxHighlightedCode and CodeBlockStyle.

SyntaxHighlightedTextEditorDefaults

object SyntaxHighlightedTextEditorDefaults

Default values used by SyntaxHighlightedTextEditor and rememberSyntaxHighlightedEditorValue.

Properties

LocalDarkHighlightTheme

val LocalDarkHighlightTheme: ProvidableCompositionLocal<HighlightTheme>

CompositionLocal that provides the dark HighlightTheme configured in HighlightThemeProvider.

LocalHighlightTheme

val LocalHighlightTheme: ProvidableCompositionLocal<HighlightTheme>

CompositionLocal that provides the active HighlightTheme to all SyntaxHighlightedCode composables in the subtree.

LocalLightHighlightTheme

val LocalLightHighlightTheme: ProvidableCompositionLocal<HighlightTheme>

CompositionLocal that provides the light HighlightTheme configured in HighlightThemeProvider.

Functions

HighlightThemeProvider

@Composable

fun HighlightThemeProvider(darkTheme: Boolean = isSystemInDarkTheme(), lightHighlightTheme: HighlightTheme = rememberTomorrowLightTheme(), darkHighlightTheme: HighlightTheme = rememberTomorrowNightTheme(), content: @Composable () -> Unit)

Provides HighlightTheme and a shared HighlightEngine to all SyntaxHighlightedCode composables in content.

rememberAlucardDarkTheme

@Composable

fun rememberAlucardDarkTheme(): HighlightTheme

Creates and remembers the built-in Dracula (dark) theme as an alias under the Alucard naming scheme. Makes the dark theme discoverable under the Alucard family name.

rememberAlucardLightTheme

@Composable

fun rememberAlucardLightTheme(): HighlightTheme

Creates and remembers the built-in Alucard (light) HighlightTheme.

rememberAtomOneDarkTheme

@Composable

fun rememberAtomOneDarkTheme(): HighlightTheme

Creates and remembers the built-in Atom One Dark HighlightTheme.

rememberAtomOneLightTheme

@Composable

fun rememberAtomOneLightTheme(): HighlightTheme

Creates and remembers the built-in Atom One Light HighlightTheme.

rememberDraculaDarkTheme

@Composable

fun rememberDraculaDarkTheme(): HighlightTheme

Creates and remembers the built-in Dracula (dark) HighlightTheme.

rememberDraculaLightTheme

@Composable

fun rememberDraculaLightTheme(): HighlightTheme

Creates and remembers the built-in Alucard (light) theme as an alias under the Dracula naming scheme. Makes the light theme discoverable under the Dracula family name.

rememberGithubDarkTheme

@Composable

fun rememberGithubDarkTheme(): HighlightTheme

Creates and remembers the built-in GitHub Dark HighlightTheme.

rememberGithubLightTheme

@Composable

fun rememberGithubLightTheme(): HighlightTheme

Creates and remembers the built-in GitHub Light HighlightTheme.

rememberHighlightedCode

@Composable

fun rememberHighlightedCode(code: String, language: String, theme: HighlightTheme = LocalHighlightTheme.current, onHighlightComplete: (HighlightResult) -> Unit? = null, onError: (HighlightException) -> Unit? = null): State<AnnotatedString?>

Pre-highlights code and remembers the resulting AnnotatedString.

rememberHighlightedCodeBothThemes

@Composable

fun rememberHighlightedCodeBothThemes(code: String, language: String, lightTheme: HighlightTheme = LocalLightHighlightTheme.current, darkTheme: HighlightTheme = LocalDarkHighlightTheme.current, onHighlightComplete: (ThemedHighlightResult) -> Unit? = null, onError: (HighlightException) -> Unit? = null): State<ThemedHighlightResult?>

Pre-highlights code for both light and dark themes in a single JS call.

rememberHighlightEngine

@Composable

fun rememberHighlightEngine(): HighlightEngine

Creates and remembers a HighlightEngine scoped to the composition.

rememberSyntaxHighlightedEditorValue

@Composable

fun rememberSyntaxHighlightedEditorValue(value: TextFieldValue, language: String, theme: HighlightTheme = LocalHighlightTheme.current, debounceMs: Long = SyntaxHighlightedTextEditorDefaults.DEBOUNCE_MS, onHighlightComplete: (HighlightResult) -> Unit? = null, onError: (HighlightException) -> Unit? = null): TextFieldValue

Runs the debounce + syntax-highlight pipeline for a live code editor and returns the display TextFieldValue ready to pass directly to BasicTextField (or any other text field that accepts TextFieldValue).

rememberTomorrowLightTheme

@Composable

fun rememberTomorrowLightTheme(): HighlightTheme

Creates and remembers the built-in Base16 Tomorrow (light) HighlightTheme.

rememberTomorrowNightTheme

@Composable

fun rememberTomorrowNightTheme(): HighlightTheme

Creates and remembers the built-in Base16 Tomorrow Night (dark) HighlightTheme.

SyntaxHighlightedCode

@Composable

fun SyntaxHighlightedCode(code: String, language: String, modifier: Modifier = Modifier, theme: HighlightTheme = LocalHighlightTheme.current, style: CodeBlockStyle = CodeBlockStyle.Default, showLineNumbers: Boolean = false, scrollState: ScrollState = rememberScrollState(), languageLabel: @Composable () -> Unit? = if (language.isNotBlank()) DefaultLanguageLabelSentinel else null, copyButton: @Composable (onClick: () -> Unit) -> Unit? = DefaultCopyButtonSentinel, onCopyClick: (String) -> Unit? = null, onHighlightComplete: (HighlightResult) -> Unit? = null, onError: (HighlightException) -> Unit? = null, placeholder: @Composable (code: String) -> Unit? = null)

Displays syntax-highlighted code in a styled block.

SyntaxHighlightedTextEditor

@Composable

fun SyntaxHighlightedTextEditor(value: TextFieldValue, onValueChange: (TextFieldValue) -> Unit, language: String, modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), shape: Shape = RectangleShape, theme: HighlightTheme = LocalHighlightTheme.current, textStyle: TextStyle = SyntaxHighlightedTextEditorDefaults.DefaultTextStyle, keyboardOptions: KeyboardOptions = SyntaxHighlightedTextEditorDefaults.CodeKeyboardOptions, cursorBrush: Brush? = null, debounceMs: Long = SyntaxHighlightedTextEditorDefaults.DEBOUNCE_MS, onHighlightComplete: (HighlightResult) -> Unit? = null, onError: (HighlightException) -> Unit? = null, indentation: String = SyntaxHighlightedTextEditorDefaults.DEFAULT_INDENTATION, autoIndentEnabled: Boolean = SyntaxHighlightedTextEditorDefaults.AUTO_INDENT_ENABLED, tabKeyInterceptionEnabled: Boolean = SyntaxHighlightedTextEditorDefaults.TAB_KEY_INTERCEPTION_ENABLED, horizontalScrollState: ScrollState? = null, verticalScrollState: ScrollState? = null)

This composable is marked experimental (ExperimentalHighlightApi). Call sites must opt in with @OptIn(ExperimentalHighlightApi::class) or propagate the annotation. The API surface (parameters, defaults, behavior) may change in future releases.