Skip to content

Commit

Permalink
Add mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
MohamedRejeb committed Sep 28, 2023
1 parent 4d48516 commit 0382ddf
Show file tree
Hide file tree
Showing 39 changed files with 1,378 additions and 42 deletions.
60 changes: 24 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
Calf is a library that allows you to easily create adaptive UIs for your Compose Multiplatform apps.


[![Kotlin](https://img.shields.io/badge/kotlin-1.9.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.20--Beta-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![MohamedRejeb](https://raw.githubusercontent.com/MohamedRejeb/MohamedRejeb/main/badges/mohamedrejeb.svg)](https://github.com/MohamedRejeb)
[![Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
[![BuildPassing](https://shields.io/badge/build-passing-brightgreen)](https://github.com/MohamedRejeb/ksoup/actions)
[![Maven Central](https://img.shields.io/maven-central/v/com.mohamedrejeb.calf/calf-ui)](https://search.maven.org/search?q=g:%22com.mohamedrejeb.calf%22%20AND%20a:%calf-ui%22)

![Calf thumbnail](images/thumbnail.png)
![Calf thumbnail](docs/images/thumbnail.png)

Calf stands for **C**ompose **A**daptive **L**ook & **F**eel

Expand Down Expand Up @@ -92,7 +92,7 @@ kotlin {

| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| ![Alert Dialog Android](images/AdaptiveAlertDialog-android.png) | ![Alert Dialog iOS](images/AdaptiveAlertDialog-ios.png) |
| ![Alert Dialog Android](docs/images/AdaptiveAlertDialog-android.png) | ![Alert Dialog iOS](docs/images/AdaptiveAlertDialog-ios.png) |

```kotlin
var showDialog by remember { mutableStateOf(false) }
Expand Down Expand Up @@ -121,7 +121,7 @@ if (showDialog) {

| Android | iOS |
|-----------------------------------------------------------------|---------------------------------------------------------|
| ![Bottom Sheet Android](images/AdaptiveBottomSheet-android.png) | ![Bottom Sheet iOS](images/AdaptiveBottomSheet-ios.png) |
| ![Bottom Sheet Android](docs/images/AdaptiveBottomSheet-android.png) | ![Bottom Sheet iOS](docs/images/AdaptiveBottomSheet-ios.png) |

```kotlin
val scope = rememberCoroutineScope()
Expand Down Expand Up @@ -164,7 +164,7 @@ Box(

| Android | iOS |
|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| ![Circular Progress Indicator Android](images/AdaptiveCircularProgressIndicator-android.png) | ![Circular Progress Indicator iOS](images/AdaptiveCircularProgressIndicator-ios.png) |
| ![Circular Progress Indicator Android](docs/images/AdaptiveCircularProgressIndicator-android.png) | ![Circular Progress Indicator iOS](docs/images/AdaptiveCircularProgressIndicator-ios.png) |

```kotlin
AdaptiveCircularProgressIndicator(
Expand All @@ -179,7 +179,7 @@ AdaptiveCircularProgressIndicator(

| Android | iOS |
|---------------------------------------------------------------|-------------------------------------------------------|
| ![Date Picker Android](images/AdaptiveDatePicker-android.png) | ![Date Picker iOS](images/AdaptiveDatePicker-ios.png) |
| ![Date Picker Android](docs/images/AdaptiveDatePicker-android.png) | ![Date Picker iOS](docs/images/AdaptiveDatePicker-ios.png) |

```kotlin
val state = rememberAdaptiveDatePickerState()
Expand All @@ -199,7 +199,7 @@ AdaptiveDatePicker(

| Android | iOS |
|---------------------------------------------------------------|-------------------------------------------------------|
| ![Time Picker Android](images/AdaptiveTimePicker-android.png) | ![Time Picker iOS](images/AdaptiveTimePicker-ios.png) |
| ![Time Picker Android](docs/images/AdaptiveTimePicker-android.png) | ![Time Picker iOS](docs/images/AdaptiveTimePicker-ios.png) |

```kotlin
val state = rememberAdaptiveTimePickerState()
Expand All @@ -220,7 +220,7 @@ AdaptiveTimePicker(

| Android | iOS |
|-------------------------------------------------|-----------------------------------------|
| ![Web View Android](images/WebView-android.png) | ![Web View iOS](images/WebView-ios.png) |
| ![Web View Android](docs/images/WebView-android.png) | ![Web View iOS](docs/images/WebView-ios.png) |

```kotlin
val state = rememberWebViewState(
Expand Down Expand Up @@ -287,7 +287,7 @@ Calf File Picker allows you to pick files from the device storage.

| Android | iOS |
|------------------------------------------------------------|----------------------------------------------------|
| ![Web View Android](images/AdaptiveFilePicker-android.png) | ![Web View iOS](images/AdaptiveFilePicker-ios.png) |
| ![Web View Android](docs/images/AdaptiveFilePicker-android.png) | ![Web View iOS](docs/images/AdaptiveFilePicker-ios.png) |

```kotlin
val pickerLauncher = rememberFilePickerLauncher(
Expand Down Expand Up @@ -316,29 +316,18 @@ Button(

`FilePickerFileType` allows you to specify the type of files you want to pick:

`FilePickerFileType.Image` - Allows you to pick images only

`FilePickerFileType.Video` - Allows you to pick videos only

`FilePickerFileType.ImageView` - Allows you to pick images and videos only

`FilePickerFileType.Audio` - Allows you to pick audio files only

`FilePickerFileType.Document` - Allows you to pick documents only

`FilePickerFileType.Text` - Allows you to pick text files only

`FilePickerFileType.Pdf` - Allows you to pick PDF files only

`FilePickerFileType.Presentation` - Allows you to pick presentation files only

`FilePickerFileType.Spreadsheet` - Allows you to pick spreadsheet files only

`FilePickerFileType.Word` - Allows you to pick compressed word only

`FilePickerFileType.All` - Allows you to pick all types of files

`FilePickerFileType.Folder` - Allows you to pick folders
* `FilePickerFileType.Image` - Allows you to pick images only
* `FilePickerFileType.Video` - Allows you to pick videos only
* `FilePickerFileType.ImageView` - Allows you to pick images and videos only
* `FilePickerFileType.Audio` - Allows you to pick audio files only
* `FilePickerFileType.Document` - Allows you to pick documents only
* `FilePickerFileType.Text` - Allows you to pick text files only
* `FilePickerFileType.Pdf` - Allows you to pick PDF files only
* `FilePickerFileType.Presentation` - Allows you to pick presentation files only
* `FilePickerFileType.Spreadsheet` - Allows you to pick spreadsheet files only
* `FilePickerFileType.Word` - Allows you to pick compressed word only
* `FilePickerFileType.All` - Allows you to pick all types of files
* `FilePickerFileType.Folder` - Allows you to pick folders

You can also specify the file types you want to pick by using the `FilePickerFileType.Custom` type:

Expand All @@ -352,9 +341,8 @@ val type = FilePickerType.Custom(

`FilePickerSelectionMode` allows you to specify the selection mode of the file picker:

`FilePickerSelectionMode.Single` - Allows you to pick a single file

`FilePickerSelectionMode.Multiple` - Allows you to pick multiple files
* `FilePickerSelectionMode.Single` - Allows you to pick a single file
* `FilePickerSelectionMode.Multiple` - Allows you to pick multiple files

## Contribution
If you've found an error in this sample, please file an issue. <br>
Expand All @@ -369,7 +357,7 @@ Also, __[follow me](https://github.com/MohamedRejeb)__ on GitHub for more librar
You can always <a href="https://www.buymeacoffee.com/MohamedRejeb"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=MohamedRejeb&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff"></a>

# License
```markdown
```
Copyright 2023 Mohamed Rejeb
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
4 changes: 4 additions & 0 deletions calf-file-picker/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
6 changes: 5 additions & 1 deletion calf-io/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
plugins {
alias(libs.plugins.kotlinMultiplatform)
alias(libs.plugins.androidLibrary)
id("module.publication")
// id("module.publication")
}

kotlin {
Expand Down Expand Up @@ -33,4 +33,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
4 changes: 4 additions & 0 deletions calf-maps/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
4 changes: 4 additions & 0 deletions calf-media/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
4 changes: 4 additions & 0 deletions calf-navigation/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
4 changes: 4 additions & 0 deletions calf-notifications/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
10 changes: 9 additions & 1 deletion calf-permissions/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ plugins {
alias(libs.plugins.kotlinMultiplatform)
alias(libs.plugins.composeMultiplatform)
alias(libs.plugins.androidLibrary)
// id("module.publication")
id("module.publication")
}

kotlin {
Expand Down Expand Up @@ -44,4 +44,12 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
4 changes: 4 additions & 0 deletions calf-sf-symbols/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
4 changes: 4 additions & 0 deletions calf-ui/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,8 @@ android {
defaultConfig {
minSdk = libs.versions.android.minSdk.get().toInt()
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11
}
}
76 changes: 76 additions & 0 deletions docs/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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 colin at colinwhite.me. 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
74 changes: 74 additions & 0 deletions docs/filepicker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# File Picker

## Installation

[![Maven Central](https://img.shields.io/maven-central/v/com.mohamedrejeb.calf/calf-file-picker)](https://search.maven.org/search?q=g:%22com.mohamedrejeb.calf%22%20AND%20a:%calf-file-picker%22)

Add the following dependency to your module `build.gradle.kts` file:

```kotlin
implementation("com.mohamedrejeb.calf:calf-file-picker:0.2.0")
```

## Usage

Calf File Picker allows you to pick files from the device storage.

| Android | iOS |
|------------------------------------------------------------|----------------------------------------------------|
| ![Web View Android](images/AdaptiveFilePicker-android.png) | ![Web View iOS](images/AdaptiveFilePicker-ios.png) |

```kotlin
val pickerLauncher = rememberFilePickerLauncher(
type = FilePickerType.Image,
selectionMode = FilePickerSelectionMode.Single,
onResult = { files ->
files.firstOrNull()?.let { file ->
// Do something with the selected file
// You can get the ByteArray of the file
file.readByteArray()
}
}
)

Button(
onClick = {
pickerLauncher.launch()
},
modifier = Modifier.padding(16.dp)
) {
Text("Open File Picker")
}
```

#### FilePickerFileType

`FilePickerFileType` allows you to specify the type of files you want to pick:

* `FilePickerFileType.Image` - Allows you to pick images only
* `FilePickerFileType.Video` - Allows you to pick videos only
* `FilePickerFileType.ImageView` - Allows you to pick images and videos only
* `FilePickerFileType.Audio` - Allows you to pick audio files only
* `FilePickerFileType.Document` - Allows you to pick documents only
* `FilePickerFileType.Text` - Allows you to pick text files only
* `FilePickerFileType.Pdf` - Allows you to pick PDF files only
* `FilePickerFileType.Presentation` - Allows you to pick presentation files only
* `FilePickerFileType.Spreadsheet` - Allows you to pick spreadsheet files only
* `FilePickerFileType.Word` - Allows you to pick compressed word only
* `FilePickerFileType.All` - Allows you to pick all types of files
* `FilePickerFileType.Folder` - Allows you to pick folders

You can also specify the file types you want to pick by using the `FilePickerFileType.Custom` type:

```kotlin
val type = FilePickerType.Custom(
"text/plain"
)
```

#### FilePickerSelectionMode

`FilePickerSelectionMode` allows you to specify the selection mode of the file picker:

* `FilePickerSelectionMode.Single` - Allows you to pick a single file
* `FilePickerSelectionMode.Multiple` - Allows you to pick multiple files
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/images/Permissions-android.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Permissions-ios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added docs/images/logo.ico
Binary file not shown.
Binary file added docs/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0382ddf

Please sign in to comment.