Skip to content

Commit

Permalink
Merge branch 'develop' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
jeluchu committed Feb 6, 2023
2 parents 1a5832f + 1d1241d commit ab4bfac
Show file tree
Hide file tree
Showing 2,742 changed files with 120,520 additions and 94,189 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/composables-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Composables bug report
about: Create a report to help us improve
title: "[UI]"
labels: bug, ui
assignees: jeluchu

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/core-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Core bug report
about: Create a report to help us improve
title: "[CORE]"
labels: bug, core
assignees: jeluchu

---

**Describe the bug**
A clear and concise description of what the bug is

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen

**Smartphone (please complete the following information):**
- Device: [e.g. Pixel 4 XL / Simulator]
- Android Version: [e.g. iOS8.1]

**Additional context**
Add any other context about the problem here
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/extensions-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Extensions bug report
about: Create a report to help us improve
title: "[KTX]"
labels: bug, ktx
assignees: jeluchu

---

**Describe the bug**
A clear and concise description of what the bug is

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen

**Smartphone (please complete the following information):**
- Device: [e.g. Pixel 4 XL / Simulator]
- Android Version: [e.g. iOS8.1]

**Additional context**
Add any other context about the problem here
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[NEW FEATURE]"
labels: enhancement
assignees: jeluchu

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
103 changes: 86 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@

![Cover Library Image](https://raw.githubusercontent.com/Jeluchu/jchucomponents-compose/develop/images/cover.png)
# Jchucomponents for Android


![Cover Library Image](https://raw.githubusercontent.com/Jeluchu/jchucomponents-compose/main/images/cover.png)

# Jchucomponents (Compose Version)
This library contains Composable elements that can be used in any application that uses the new android layout system (Jetpack Compose).
## Introduction

This library is intended to facilitate the work of developers so that they can make applications in a faster way and with less code. That is why in addition to having design components (Compose), it also includes various functions and extensions with which to accelerate the development of applications from scratch, or current, as well as including components for the implementation of architectures (MVVM) or perform various common functions.

**The current version of the library is as follows:**
[![](https://jitpack.io/v/Jeluchu/jchucomponents-compose.svg)](https://jitpack.io/#Jeluchu/jchucomponents-compose)
## Versions prior to v1

Versions released prior to v1.x.x can still be used although it is not recommended due to the lack of optimizations and the lack of documentation for those versions, in case you want to use it, remember that the implementation is not the same as the current one

# USE IT
### Old implementation

To use the library add the following dependencies to Gradle:

**For Gradle:**

Add the maven repository:
>
>
allprojects {
repositories {
...
Expand All @@ -27,12 +25,12 @@ Add the maven repository:
}


Add the **Jchucomponents** dependencies
Add the **jchucomponents-compose** dependencies

***Gradle:***
>
>
dependencies {
implementation 'com.github.Jeluchu:jchucomponents-compose:Tag'
implementation 'com.github.Jeluchu:jchucomponents-compose:0.10.0'
}

**For Kotlin DSL:**
Expand All @@ -45,11 +43,82 @@ Add the maven repository:
maven("https://jitpack.io")
}
}

Add the **Jchucomponents** dependencies

>
Add the **jchucomponents-compose** dependencies

>
dependencies {
implementation("com.github.Jeluchu:jchucomponents-compose:Tag")
implementation("com.github.Jeluchu:jchucomponents-compose:0.10.0")
}



These versions used `JavaVersion.VERSION_11` please take this into account to adjust your project with the compatible versions as it may cause problems when compiling your project
```
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
```

## Use Library

In the repository it is not only the library project but also the example project "sample_client";

thanks to it you will learn how to use the library.

*There are different ways of adding this library to your code*

### Gradle / Maven dependency

At the moment we do not have a publishing mechanism to a maven repository so the easiest way to add the library to your app is via a JitPack Dependency [![](https://jitpack.io/v/jeluchu/jchucomponents.svg)](https://jitpack.io/#jeluchu/jchucomponents)

>
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}

Add the **jchucomponents** dependencies, it include jchucomponents-core library and its library dependencies.

>
dependencies {
implementation 'com.github.jeluchu.jchucomponents:jchucomponents-core:1.x.x'
}

If you want to get the design components in Jetpack Compose, you will need to include jchucomponents-ui library and its library dependencies

>
dependencies {
implementation 'com.github.jeluchu.jchucomponents:jchucomponents-ui:1.x.x'
}

### As a git submodule

Basically get this code and compile it having it integrated via a git submodule:

1. go into your own apps directory on the command line and add this lib as a submodule: ```git submodule add https://github.com/jeluchu/jchucomponents jeluchu-jchucomponents```

2. Import/Open your app in Android Studio

## Development process

For the development of new features by the developer community, the following steps will be followed, the review of the issues will be in charge of the official contributors of the library

* Create an **issue with feature request**
* **Review** of the feature request or issue and analyze it
* Development of new features
* Documentation of new features
* Create [pull request](https://github.com/jeluchu/jchucomponents/pulls)

## Compatibility

JchuComponents is compatible with newer versions of Android Studio, and includes support for `JavaVersion.VERSION_11` and **recent targets for the latest versions of Android**

## Contributors ✨

Here are the **main contributors to the Android library**,

<table>
<tr>
<td align="center"><a href="https://github.com/Jeluchu"><img src="https://avatars.githubusercontent.com/u/32357592?v=4" width="100px;" alt=""/><br /><sub><b>Jéluchu</b></sub></a><br/><a href="https://about.jeluchu.com/" title="About Jelu">🌍</a> <a href="https://twitter.com/Jeluchu" title="Twitter">📢</a><a href="https://www.linkedin.com/in/jesusmariacalderon/" title="LinkedIn">🔍</a></td></tr></table>
66 changes: 37 additions & 29 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,19 @@
plugins {
id 'com.android.application'
id 'kotlin-android'
id 'org.jetbrains.dokka'
}

android {
compileSdk 32

compileSdk 33

defaultConfig {
applicationId "com.jeluchu.compposecomponents"
applicationId "com.jeluchu.composer"
minSdk 22
targetSdk 32
targetSdk 33
versionCode 1
versionName "1.0"
versionName "1.0.0"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
Expand All @@ -34,38 +36,44 @@ android {
}

composeOptions {
kotlinCompilerExtensionVersion = "1.2.0-rc01"
kotlinCompilerExtensionVersion = "1.3.2"
}

compileOptions {
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
}
namespace 'com.jeluchu.compposecomponents'
}

dependencies {
dokkaHtml.configure {

implementation project(':jchucomponentscompose')
implementation 'androidx.appcompat:appcompat:1.4.2'
implementation 'com.google.android.material:material:1.6.1'
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'

// JETPACK COMPOSE -----------------------------------------------------------------------------
implementation 'androidx.compose.ui:ui:1.1.1'
implementation 'androidx.compose.material:material:1.1.1'
implementation 'androidx.compose.ui:ui-tooling-preview:1.1.1'
implementation 'androidx.activity:activity-compose:1.4.0'
debugImplementation 'androidx.compose.ui:ui-tooling:1.1.1'
implementation 'androidx.activity:activity-compose:1.4.0'
implementation 'androidx.compose.material:material-icons-extended:1.1.1'
implementation 'androidx.compose.foundation:foundation:1.1.1'
implementation 'androidx.compose.foundation:foundation-layout:1.1.1'
implementation 'androidx.compose.animation:animation:1.1.1'
implementation 'androidx.compose.runtime:runtime:1.1.1'
implementation 'androidx.compose.runtime:runtime-livedata:1.1.1'
implementation 'androidx.constraintlayout:constraintlayout-compose:1.0.1'
implementation 'androidx.navigation:navigation-compose:2.4.2'
implementation 'androidx.activity:activity-compose:1.4.0'
outputDirectory.set(file("../docs"))
moduleName.set("$rootProject.name")
suppressInheritedMembers.set(true)
pluginsMapConfiguration.set(
[
"org.jetbrains.dokka.base.DokkaBase": """{
"footerMessage": "Made with ❤️ at <b><a href=\\"https://about.jeluchu.com\\">Jéluchu</a></b> © 2022",
"customStyleSheets": ["${file("../logo-style.css")}"]
}"""
]
)

dokkaSourceSets {
named("main") {
includes.from("../modules.md")
includeNonPublic.set(true)
}
}
}


namespace 'com.jeluchu.composer'

}

dependencies {
implementation libs.bundles.ui.compose
implementation project(':jchucomponents-core')
implementation project(':jchucomponents-ui')
implementation project(':jchucomponents-ktx')
}
2 changes: 1 addition & 1 deletion app/proguard-rules.pro
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
# proguardFiles setting in build.gradle.kts.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
Expand Down
11 changes: 4 additions & 7 deletions app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
<?xml version="1.0" encoding="utf-8"?><!--
~
~ Copyright 2022 Jeluchu
~
Expand All @@ -11,15 +10,13 @@

<application
android:allowBackup="true"
android:fullBackupContent="false"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="true"
android:theme="@style/Theme.CompposeComponents">
android:supportsRtl="true">
<activity
android:name=".MainActivity"
android:exported="true" >
android:name="com.jeluchu.composer.MainActivity"
android:exported="true">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
Expand Down
Loading

0 comments on commit ab4bfac

Please sign in to comment.