Skip to content

Commit 9bc6c84

Browse files
MateuszMrozMateuszMroz
committed
Merge pull request #29 from mudita/task/PARP-152
[PARP-152] Clean up project
2 parents f76278a + 37acef5 commit 9bc6c84

File tree

79 files changed

+1093
-168
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+1093
-168
lines changed

‎.DS_Store‎

-6 KB
Binary file not shown.

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,5 @@ google-services.json
3131

3232
# Android Profiling
3333
*.hprof
34+
35+
.DS_Store

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 104 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,112 @@
1-
# E-ink Component Library for Android
1+
# Mudita Mindful Design (MMD)
22

3-
This library provides a set of ready-to-use UI components optimized for e-ink displays on Android. These components are designed to minimize screen flickering, conserve energy, and provide a readable interface.
3+
A UI component library optimized for e‑ink displays on Android, built on top of Jetpack Compose Material 3 guidelines and classes. Our goal is to provide a consistent, predictable set of components that respects Material Design while addressing the specifics of e‑ink displays.
44

5-
## Features
5+
> We intentionally rely on Material Design (Material 3) classes and patterns. This is by design and a good practice. It keeps us aligned with the Android ecosystem while adapting behavior and styling to e‑ink.
6+
7+
## Why e‑ink?
8+
E‑ink displays differ from standard LCD/OLED:
9+
- slower refresh rates and potential ghosting/afterimage,
10+
- limited color palette (often grayscale),
11+
- great daylight readability with low power consumption,
12+
- animations and visual effects (e.g., ripple) should be minimized; updates should be frugal.
613

7-
* **E-ink Optimized:** Components are designed with the limitations of e-ink displays in mind, such as slow refresh rates and limited color palettes (or grayscale).
8-
* **Flicker Minimization:** Implementation that minimizes the need for full screen refreshes, reducing flickering.
9-
* **Energy Efficiency:** Design focused on efficient resource utilization to minimize energy consumption.
10-
* **Readable Interface:** Components designed with readability in mind, even in challenging lighting conditions.
14+
MMD minimizes flicker, reduces unnecessary animations, and simplifies color and typography to make the UI readable and energy‑efficient.
1115

12-
## Installation
16+
## Features
17+
- **E‑ink optimized**: default color scheme, typography, and interaction patterns for e‑ink.
18+
- **Material Design 3‑based**: integration with `MaterialTheme` and compatibility with M3 components.
19+
- **Ripple disabled**: ripple effects are turned off by default for better UX on e‑ink.
20+
- **Consistent typography**: ready‑to‑use `eInkTypography` and `eInkColorScheme` (monochromatic).
21+
- **Component set**: buttons, text fields, switches, tabs, app bars, and more.
1322

14-
To install the library, add the dependency to your module's `build.gradle` file:
23+
## Setup
24+
```kotlin
25+
dependencyResolutionManagement {
26+
repositories {
27+
mavenCentral()
28+
maven { url = uri("https://jitpack.io") }
29+
}
30+
}
1531

16-
```gradle
1732
dependencies {
18-
implementation("com.mudita:mmd-core:${mmd-version}")
33+
implementation("com.github.mudita.MMD:mmd-core:release.{version}")
34+
}
35+
36+
```
37+
38+
## Configuration and theming
39+
Enable the MMD theme in your Compose tree. By default, it applies an e‑ink‑friendly color scheme and typography and disables ripple effects globally.
40+
41+
```kotlin
42+
import com.mudita.mmd.components.buttons.ButtonMMD
43+
import com.mudita.mmd.components.text.TextMMD
44+
import com.mudita.mmd.ThemeMMD
45+
46+
@Composable
47+
fun App() {
48+
ThemeMMD {
49+
ButtonMMD(onClick = { /* ... */ }) {
50+
TextMMD("Hello e‑ink")
51+
}
52+
}
53+
}
54+
```
55+
56+
## Using components
57+
MMD works well with both Material 3 components and MMD‑provided components. Use our components where they bring e‑ink optimizations; otherwise, standard M3 components will remain consistent via theming.
58+
59+
```kotlin
60+
import com.mudita.mmd.components.buttons.ButtonMMD
61+
import com.mudita.mmd.components.text.TextMMD
62+
63+
@Composable
64+
fun Screen() {
65+
ButtonMMD(onClick = { /* ... */ }) {
66+
TextMMD(text = "Action")
67+
}
1968
}
69+
```
70+
71+
> Component names may vary by module and version. Explore `com.mudita.mmd.components.*` in your IDE for the full list and API.
72+
73+
## Accessibility and readability
74+
- contrast and font sizes tuned for e‑ink,
75+
- avoid animations/effects that reduce readability,
76+
- utilities to support accessibility (e.g., unified text styles).
77+
78+
## Performance on e‑ink – best practices
79+
- limit animations, auto‑refresh, and fancy transitions,
80+
- avoid frequent state changes leading to redraws,
81+
- prefer monochrome graphics and simple shapes,
82+
- ripple and heavy touch effects are globally disabled by `ThemeMMD`.
83+
84+
## Demo
85+
![MMD Demo](mmd-demo.gif)
86+
87+
## Documentation
88+
Full documentation is available here: [📘 Open Documentation](https://zeroheight.com/956ff055a/p/79359a-mudita-mindful-design)
89+
90+
## Contributing
91+
- Please file issues and propose PRs.
92+
- Follow Compose/Material style and code conventions.
93+
- Add tests and usage examples for new components.
94+
95+
## License
96+
Apache License 2.0.
97+
98+
```
99+
Copyright 2025 The Android Open Source Project
100+
101+
Licensed under the Apache License, Version 2.0 (the "License");
102+
you may not use this file except in compliance with the License.
103+
You may obtain a copy of the License at
104+
105+
http://www.apache.org/licenses/LICENSE-2.0
106+
107+
Unless required by applicable law or agreed to in writing, software
108+
distributed under the License is distributed on an "AS IS" BASIS,
109+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
110+
See the License for the specific language governing permissions and
111+
limitations under the License.
112+
```

‎gradle.properties‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ android.useAndroidX=true
77
android.nonTransitiveRClass=true
88

99
library.group=com.mudita
10-
library.artefactId=MMD
10+
library.artifactId=MMD
1111
library.namespace=com.mudita.mmd
1212
library.compileSdk=34
1313
library.minSdk=28
1414
library.targetSdk=34
15-
library.version=0.0.15
15+
library.version=1.0.0

‎gradle/wrapper/gradle-wrapper.properties‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
#
2+
# Copyright 2025 The Android Open Source Project
3+
#
4+
# Based on Material 3. Modified by Mudita Sp. z o.o.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
119
#Fri Feb 28 08:42:55 CET 2025
220
distributionBase=GRADLE_USER_HOME
321
distributionPath=wrapper/dists

‎gradlew‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
#!/usr/bin/env sh
2-
31
#
4-
# Copyright 2015 the original author or authors.
2+
# Copyright 2025 The Android Open Source Project
3+
#
4+
# Based on Material 3. Modified by Mudita Sp. z o.o.
55
#
66
# Licensed under the Apache License, Version 2.0 (the "License");
77
# you may not use this file except in compliance with the License.
88
# You may obtain a copy of the License at
99
#
10-
# https://www.apache.org/licenses/LICENSE-2.0
10+
# http://www.apache.org/licenses/LICENSE-2.0
1111
#
1212
# Unless required by applicable law or agreed to in writing, software
1313
# distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,14 +16,6 @@
1616
# limitations under the License.
1717
#
1818

19-
##############################################################################
20-
##
21-
## Gradle start up script for UN*X
22-
##
23-
##############################################################################
24-
25-
# Attempt to set APP_HOME
26-
# Resolve links: $0 may be a link
2719
PRG="$0"
2820
# Need this for relative symlinks.
2921
while [ -h "$PRG" ] ; do

0 commit comments

Comments
 (0)