diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5911c33 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**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 + +**Sample code** +Any code snippets/samples/projects helping to reproduce and demonstrate an issue. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - Device: [e.g. Pixel XL] + - OS: [e.g. Android 10] + - Library version [e.g. 1.0.1] +- Used Android SDK library versions [androidx.appcompat:appcompat:1.2.0-alpha03...] +- Used gradle and wrapper version +- Used tooling / Android Studio version +- Other potentially conflicting libraries + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**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. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..2f2f17b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at side.codes@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md index 1942726..5d8d230 100644 --- a/README.md +++ b/README.md @@ -3,54 +3,28 @@ *:avocado: Handy, :snake: flexible and :zap: lightning-fast material color picking UI component for Android* :speech_balloon: Work-In-Progress -## Roadmap -- [ ] Add more picker types - - [x] HLS SeekBars - - [ ] RGB SeekBars - - [ ] RGB circle - - [ ] RGB plane - - [x] CMYK SeekBars - - [x] Alpha SeekBars - - [ ] HSL (S+L) plane - - [x] Swatches -- [ ] Extend picker types - - [ ] CMYK SeekBars coloring modes - - [ ] More awesome swatches - - [ ] More supported alpha color models -- [x] Sample buttons -> radios -- [x] Remove sample app child press delays -- [x] Enhance API -- [x] Add XML attributes -- [x] Provide *git-flow* -- [ ] Automate release/publish flow -- [x] Add thumb animation -- [x] Add *MaterialDrawer* & sample fragments -- [x] Add more *HSLColorPickerSeekBar* checks and reduce calls count -- [x] Add more encapsulation to limit picker modification capabilities -- [x] Package repository publish *(Bintray)* -- [ ] Add *Rx* support -- [x] Add/Revisit *RecyclerView* support -- [x] Add sample app icon -- [ ] Add logger solution -- [ ] Add sample app analytics -- [ ] Add GIFs media -- [ ] Add call flow diagram -- [ ] Add tests -- [ ] Add docs -- [ ] Add contribution guidelines -- [x] Add OSS licenses -- [x] Add license +## :pill: Features + +- Clean, easy-to-use components and API +- High performance +- Material styling in mind +- Standard Android SDK view family +- Wide color models support +- Tooling and utilities +- Alpha channel support +- Cutting edge tech stack +- Active development and support -## Setup +## :hammer: Setup Gradle dependency: ```gradle -implementation "codes.side:andcolorpicker:0.1.0" +implementation "codes.side:andcolorpicker:0.2.0" ``` -## Picker types +## :art: Picker types ### HSL (hue, saturation, lightness) @@ -59,6 +33,8 @@ implementation "codes.side:andcolorpicker:0.1.0" ![](github/type_hsl.png) #### Layout XML Snippet + +Basic HSL components: ```xml +``` - +Supported `hslMode` values: +- `hue` (default) +- `saturation` +- `lightness` - +Supported `hslColoringMode` values: +- `pure` (default) +- `output` +Alpha component: +```xml ``` -## License +Supported `cmykMode` values: +- `cyan` (default) +- `magenta` +- `yellow` +- `black` + +Supported `cmykColoringMode` values: +- `pure` (default) +- `output` + +### Swatches + +SwatchView component: +```xml + +``` + +#### Kotlin Snippet: +```kotlin +swatchView.setSwatchPatternTint( + Color.LTGRAY +) + +swatchView.setSwatchColor( + IntegerHSLColor().also { + it.setFromColorInt( + ColorUtils.setAlphaComponent( + Color.MAGENTA, + 128 + ) + ) + } +) +``` + +## :rocket: Roadmap + +- [ ] Add more picker types + - [x] HLS SeekBars + - [ ] RGB SeekBars + - [ ] RGB circle + - [ ] RGB plane + - [ ] HSV/HSB seekbars + - [x] CMYK SeekBars + - [x] Alpha SeekBars + - [ ] HSL (S+L) plane + - [ ] LAB + - [ ] XYZ + - [ ] YPbPr + - [x] Swatches +- [ ] Extend picker types + - [ ] CMYK SeekBars coloring modes + - [ ] More awesome swatches + - [ ] More supported alpha color models +- [x] Sample buttons -> radios +- [x] Remove sample app child press delays +- [x] Enhance API +- [x] Add XML attributes +- [x] Provide *git-flow* +- [ ] Automate release/publish flow +- [x] Add thumb animation +- [x] Add *MaterialDrawer* & sample fragments +- [x] Add more *HSLColorPickerSeekBar* checks and reduce calls count +- [x] Add more encapsulation to limit picker modification capabilities +- [x] Package repository publish *(Bintray)* +- [ ] Add *Rx* support +- [x] Add/Revisit *RecyclerView* support +- [x] Add sample app icon +- [ ] Add logger solution +- [ ] Add sample app analytics +- [ ] Add GIFs media +- [ ] Add call flow diagram +- [ ] Add tests +- [ ] Add docs +- [ ] Add contribution guidelines +- [x] Add OSS licenses +- [x] Add license + +## :memo: License ``` Copyright 2020 Illia Achour diff --git a/andcolorpicker/build.gradle b/andcolorpicker/build.gradle index 2b8294d..01d0257 100644 --- a/andcolorpicker/build.gradle +++ b/andcolorpicker/build.gradle @@ -47,7 +47,7 @@ dependencies { publish { def groupProjectID = "codes.side" def artifactProjectID = "andcolorpicker" - def publishVersionID = "0.1.0" + def publishVersionID = "0.2.0" userOrg = "side-codes" repoName = "andColorPicker" groupId = groupProjectID diff --git a/app/build.gradle b/app/build.gradle index 8a1bc22..eb78f39 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -54,9 +54,9 @@ dependencies { implementation "androidx.fragment:fragment-ktx:1.3.0-alpha02" implementation "androidx.constraintlayout:constraintlayout:2.0.0-beta4" implementation "com.google.android.material:material:1.2.0-alpha05" - implementation "com.mikepenz:materialdrawer:8.0.0-rc01" + implementation "com.mikepenz:materialdrawer:8.0.0-rc02" - implementation "com.mikepenz:iconics-core:5.0.0-b01" + implementation "com.mikepenz:iconics-core:5.0.0" implementation "com.mikepenz:material-design-icons-dx-typeface:5.0.1.0-kotlin@aar" implementation "com.mikepenz:fontawesome-typeface:5.9.0.0-kotlin@aar" diff --git a/app/src/main/java/codes/side/andcolorpicker/app/activity/MainActivity.kt b/app/src/main/java/codes/side/andcolorpicker/app/activity/MainActivity.kt index dfa1cf0..8c8de49 100644 --- a/app/src/main/java/codes/side/andcolorpicker/app/activity/MainActivity.kt +++ b/app/src/main/java/codes/side/andcolorpicker/app/activity/MainActivity.kt @@ -208,6 +208,11 @@ class MainActivity : AppCompatActivity(), MaterialDesignDx.Icon.gmf_print, { CMYKSeekBarFragment() } ), + CMYK_SEEK_BAR_GITHUB( + "CMYK SeekBar GitHub", + FontAwesome.Icon.faw_github, + { CMYKSeekBarGithubSampleFragment() } + ), RGB_SEEK_BAR( "RGB SeekBar", MaterialDesignDx.Icon.gmf_space_bar, diff --git a/app/src/main/java/codes/side/andcolorpicker/app/fragment/CMYKSeekBarGithubSampleFragment.kt b/app/src/main/java/codes/side/andcolorpicker/app/fragment/CMYKSeekBarGithubSampleFragment.kt new file mode 100644 index 0000000..5dee4a0 --- /dev/null +++ b/app/src/main/java/codes/side/andcolorpicker/app/fragment/CMYKSeekBarGithubSampleFragment.kt @@ -0,0 +1,6 @@ +package codes.side.andcolorpicker.app.fragment + +import androidx.fragment.app.Fragment +import codes.side.andcolorpicker.app.R + +class CMYKSeekBarGithubSampleFragment : Fragment(R.layout.fragment_cmyk_seek_bar_github_sample) diff --git a/app/src/main/res/layout/fragment_cmyk_seek_bar_github_sample.xml b/app/src/main/res/layout/fragment_cmyk_seek_bar_github_sample.xml new file mode 100644 index 0000000..70e1cc9 --- /dev/null +++ b/app/src/main/res/layout/fragment_cmyk_seek_bar_github_sample.xml @@ -0,0 +1,33 @@ + + + + + + + + + + + diff --git a/build.gradle b/build.gradle index 3c1c52f..8f6d8a3 100644 --- a/build.gradle +++ b/build.gradle @@ -1,5 +1,5 @@ buildscript { - ext.kotlin_version = "1.3.70" + ext.kotlin_version = "1.3.71" repositories { google() jcenter() diff --git a/github/picker_hsl.png b/github/picker_hsl.png new file mode 100644 index 0000000..aff9e05 Binary files /dev/null and b/github/picker_hsl.png differ diff --git a/integrationapp/build.gradle b/integrationapp/build.gradle index 4e751de..9908a6c 100644 --- a/integrationapp/build.gradle +++ b/integrationapp/build.gradle @@ -39,7 +39,7 @@ android { dependencies { implementation fileTree(dir: "libs", include: ["*.jar"]) - implementation "codes.side:andcolorpicker:0.1.0" + implementation "codes.side:andcolorpicker:0.2.0" implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" implementation "androidx.appcompat:appcompat:1.2.0-alpha03" diff --git a/integrationapp/src/main/res/layout/activity_main.xml b/integrationapp/src/main/res/layout/activity_main.xml index e08faaa..100181b 100644 --- a/integrationapp/src/main/res/layout/activity_main.xml +++ b/integrationapp/src/main/res/layout/activity_main.xml @@ -7,12 +7,12 @@ android:layout_height="match_parent" tools:context=".MainActivity"> - + android:layout_height="wrap_content" + app:layout_constraintBottom_toBottomOf="parent" + app:layout_constraintEnd_toEndOf="parent" + app:layout_constraintStart_toStartOf="parent" + app:layout_constraintTop_toTopOf="parent" />