Hikage/README.md

Hikage

An Android responsive UI building tool.

English | 简体中文

	BetterAndroid

This project belongs to the above-mentioned organization, click the link above to follow this organization and discover more good projects.

What's this

This is an Android responsive UI build tool designed to focus on Real-time code building UI.

The name is taken from the original song "Haruhikage" in "BanG Dream It's MyGO!!!!!".

Click to layout Haruhikage

なんで春日影レイアウト使いの？

Unlike Jetpack Compose's declarative UI, Hikage focuses on Android native platforms, and its design goal is to enable developers to quickly build UIs and directly support Android native components.

Hikage is just a UI build tool and does not provide any UI components themselves.

Rejecting duplicate wheels, our solution is always compatible and efficient. Now you can abandon ViewBinding and XML and even findViewById and try to use the code layout directly.

The properties in Android view will be automatically generated with the Gradle plugin, and you can use it like in XML.

It does not need to consider how to complete complex attribute settings in the code, especially some third-party libraries do not provide dynamic modifications to their custom views.

Effects

Original layout

<LinerLayout
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:padding="16dp">

    <TextView
        android:id="@+id/text_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello, World!"
        android:textSize="16sp"
        android:textColor="#000000"
        android:layout_marginTop="16dp"
        android:layout_marginStart="16dp"
        android:layout_marginEnd="16dp"
        android:layout_marginBottom="16dp"
        android:gravity="center" />
</LinerLayout>

Using Hikage

// In Activity, you can use the extension function.
setContentView {
    LinearLayout(
        attrs = {
            android.layout_width = MATCH_PARENT
            android.layout_height = MATCH_PARENT
            android.orientation = VERTICAL
            android.padding = 16.dp
        },
        // You can manually specify layout parameters.
        lpparams = {
            gravity = Gravity.CENTER
        }
    ) {
        TextView(
            // You can set properties directly using attrs without considering who they belong to.
            attrs = {
                android.id = R.id.text_view
                android.layout_width = WRAP_CONTENT
                android.layout_height = WRAP_CONTENT
                android.text = "Hello, World!"
                android.textSize = 16.sp
                android.textColor = Color.BLACK
                android.marginTop = 16.dp
                android.marginStart = 16.dp
                android.marginEnd = 16.dp
                android.marginBottom = 16.dp
                android.gravity = Gravity.CENTER
                // Or use string form to set properties (note that there is no spelling check).
                namespace("android") {
                    set("id", R.id.text_view)
                    set("layout_margin", 16.dp)
                    set("layout_gravity", Gravity.CENTER)
                    // ...
                }
            },
            // You can also manually specify layout parameters.
            lpparams = {
                gravity = Gravity.CENTER
            },
            // Perform initialization operations.
            // You can also manually set properties.
            initialize = {
                text = "Hello, World!"
                textSize = 16f
                setTextColor(Color.BLACK)
                // Or more operations.
                doOnLayout {
                    // ...
                }
            }
        )
    }
}
// You can also build the root layout directly, but you need to have a UI Context.
val context: Context
// Make sure the Context is UI Context.
if (!context.isUiContext) return
// It returns the type (generic) of the first layout, such as LinearLayout below.
// The layout will be built immediately and cannot be modified.
// Please be careful to make sure the context parameter is initialized.
val root = Hikageable(
    context = context,
    // You can also customize the actions after each view is created.
    onViewCreated = { name, view ->
        // ...
    }
) {
    LinearLayout(
        attrs = {
            // ...
        },
        lpparams = {
            // ...
        }
    ) {
        // ...
    }
}

Hikage may have plans to support Java, but Kotlin is still recommended.

WIP

This project is still a work in progress. If you have any suggestions or feedback, feel free to open an issue or a pull request.

Promotion

Hey, please stay! 👋

Here are related projects such as Android development tools, UI design, Gradle plugins, Xposed Modules and practical software.

If the project below can help you, please give me a star!

All projects are free, open source, and follow the corresponding open source license agreement.

→ To see more about my projects, please click here ←

Star History

License

• Apache-2.0

Apache License Version 2.0

Copyright (C) 2019 HighCapable

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

    https://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.

Copyright © 2019 HighCapable