import{_ as r,r as i,o as p,c as d,b as e,d as n,a as s,w as o,e as t}from"./app-ZnF1aHNS.js";const c={},u=t('

Quick Start

Integrate Hikage into your project.

Project Requirements

The project needs to be created using Android Studio or IntelliJ IDEA and must be an Android or Kotlin Multiplatform project with integrated Kotlin environment dependencies.

',4),h={href:"https://developer.android.com/studio",target:"_blank",rel:"noopener noreferrer"},m={href:"https://www.jetbrains.com/idea",target:"_blank",rel:"noopener noreferrer"},y=e("li",null,[e("p",null,"Kotlin 1.9.0+, Gradle 8+, Java 17+, Android Gradle Plugin 8+")],-1),v=e("h3",{id:"configure-repositories",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-repositories","aria-hidden":"true"},"#"),n(" Configure Repositories")],-1),b=e("p",null,[n("The dependencies of "),e("code",null,"Hikage"),n(" are published in "),e("strong",null,"Maven Central"),n(" and our public repository, you can use the following method to configure repositories.")],-1),g={href:"https://github.com/HighCapable/SweetDependency",target:"_blank",rel:"noopener noreferrer"},A=t(`

Configure repositories in your project's SweetDependency configuration file.

repositories:
  google:
  maven-central:
  # (Optional) You can add this URL to use our public repository
  # When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
  # For details, please visit: https://github.com/HighCapable/maven-repository
  highcapable-maven-releases:
    url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases

Traditional Method

Configure dependency in your project's build.gradle.kts.

repositories {
    google()
    mavenCentral()
    // (Optional) You can add this URL to use our public repository
    // When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
    // For details, please visit: https://github.com/HighCapable/maven-repository
    maven("https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases")
}

Configure Java Version

Modify the Java version of Kotlin in your project's build.gradle.kts to 17 or above.

Kotlin DSL

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget = "17"
    }
}

Functional Overview

The project is divided into multiple modules. You can choose the module you wish to include as a dependency in your project, but be sure to include the hikage-core module.

Click the corresponding module below to view detailed feature descriptions.

`,13),D=e("h2",{id:"demo",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#demo","aria-hidden":"true"},"#"),n(" Demo")],-1),C={href:"https://github.com/BetterAndroid/Hikage/tree/main/samples",target:"_blank",rel:"noopener noreferrer"};function B(k,f){const l=i("ExternalLinkIcon"),a=i("RouterLink");return p(),d("div",null,[u,e("ul",null,[e("li",null,[e("p",null,[n("Android Studio (It is recommended to get the latest version from "),e("a",h,[n("here"),s(l)]),n(")")])]),e("li",null,[e("p",null,[n("IntelliJ IDEA (It is recommended to get the latest version from "),e("a",m,[n("here"),s(l)]),n(")")])]),y]),v,b,e("p",null,[n("We recommend using Kotlin DSL as the Gradle build script language and "),e("a",g,[n("SweetDependency"),s(l)]),n(" to manage dependencies.")]),A,e("ul",null,[e("li",null,[s(a,{to:"/en/library/hikage-core.html"},{default:o(()=>[n("hikage-core")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-compiler.html"},{default:o(()=>[n("hikage-compiler")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-extension.html"},{default:o(()=>[n("hikage-extension")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-extension-betterandroid.html"},{default:o(()=>[n("hikage-extension-betterandroid")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-extension-compose.html"},{default:o(()=>[n("hikage-extension-compose")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-widget-androidx.html"},{default:o(()=>[n("hikage-widget-androidx")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-widget-material.html"},{default:o(()=>[n("hikage-widget-material")]),_:1})])]),D,e("p",null,[n("You can find some samples "),e("a",C,[n("here"),s(l)]),n(" to view the corresponding demo project to better understand how these functions work and quickly select the functions you need.")])])}const x=r(c,[["render",B],["__file","quick-start.html.vue"]]);export{x as default};