Skip to content

Commit

Permalink
First Release of library
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Beck committed Mar 18, 2021
0 parents commit e19f01c
Show file tree
Hide file tree
Showing 49 changed files with 2,241 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to `FixedHeaderTableLayout`

## Table of contents

- [I need help/I have a question](#i-need-helpi-have-a-question)
- [Reporting a bug](#reporting-a-bug)
- [Suggest a new feature](#suggest-a-new-feature)
- [Contributing to the project](#contributing-to-the-project)

## I need help/I have a question

If you need help to integrate this library in your project, or if you have a generic question about it, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/android-tablelayout), with the `android-tablelayout` tag and referencing the library.

## Reporting a bug

If the library is not behaving as you would expect, please [open a new issue](https://github.com/Zardozz/FixedHeaderTableLayout/issues/new?labels=bug&template=bug_report.md), after checking that it hasn't been reported yet.
Don't forget to provide as much information as you can:

- What are you trying to do?
- What happened instead?
- In case of crash, include the stacktace.
- Code for a minimum reproducible example.
- Which version of the library are you using?
- Which version of Android is this issue happening on?

## Suggest a new feature

If you would like a new feature to be added to the library, please [open a new issue](https://github.com/Zardozz/FixedHeaderTableLayout/issues/new?labels=enhancement&template=feature_request.md) to describe it.

## Contributing to the project

Every contribution is welcome to the library. Simply [open a new Pull Request](https://github.com/Zardozz/FixedHeaderTableLayout/compare) with your changes, so they can be reviewed and merged into the project, and eventually released to everyone.

Note that by making a contribution to this project you are agreeing to have your contributions governed by the [MIT License](https://github.com/Zardozz/FixedHeaderTableLayout/blob/master/LICENSE) copyright statement.
This means that to the extent possible under law, you transfer all copyright and related or neighbouring rights of the code or documents you contribute to the project itself. You also represent that you have the authority to perform the above waiver with respect to the entirety of you contributions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
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

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

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

**Stacktrace**
If applicable, add the stacktrace you encountered.

**Code for a Minimum Reproducible example**
To assist investigation a Minimum Reproducible example App should be included.

**Tools:**
- `FixedHeaderTableLayout` version: [e.g. 0.0.0.1]
- Android version: [e.g. 11]

**Additional context**
Add any other context about the problem here.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Stack Overflow
url: https://stackoverflow.com/questions/tagged/android-tablelayout
about: Please ask your questions here, with the `android-tablelayout` tag
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: ''
labels: enhancement
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.
20 changes: 20 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
*.iml
.gradle
/local.properties
/.idea/caches
/.idea/libraries
/.idea/modules.xml
/.idea/workspace.xml
/.idea/navEditor.xml
/.idea/assetWizardSettings.xml
/.idea/*
.DS_Store
/build
/captures
.externalNativeBuild
.cxx
local.properties
/gradle/wrapper/gradle-wrapper.jar
/gradle/wrapper/gradle-wrapper.properties
/gradlew
/gradlew.bat
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Andrew Beck

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
88 changes: 88 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<div align="center">
<h2>Fixed Header Table Layout for Android</h2>
<p align="center">
<p>FixedHeaderTableLayout is a powerful Android library for displaying complex data structures and rendering tabular data composed of rows, columns and cells.</p>
<p>This repository also contains a sample app that is designed to show you how to create your own FixedHeaderTableLayout in your application.</p>
<p>FixedHeaderTableLayout is similar in construction and use as to Android's TableLayout</p>
</p>
</div>

<p align="center">
<img src="https://raw.githubusercontent.com/Zardozz/FixedHeaderTableLayout/master/art/FixedHeaderTableLayout.gif">
</p>

# Note
<h1>This Library is current in development and is considered in an Alpha state</h1>

## Features
- [x] 1 to X number of rows can be fixed as column headers at the top of the table
- [x] 1 to X number of rows can be fixed as row headers at the left of the table
- [x] Multi direction scrolling is available if the table is larger than the screen
- [x] Pinch Zoom is available
- [x] Standard scrollbars are available
- [x] Each column width value will be automatically adjusted to fit the largest cell in the column.
- [x] Each row height value will be automatically adjusted to fit the largest cell in the row.
- [x] Support for API 16 updwards

## Feature TODO list
- [x] Nothing is clickable in the table yet.
- [x] Corner layout location and layout direction to support Right to Left Languages
- [x] Some type of column span (Nested Tables) support
- [x] Making the fixed headers optional (at least one of each is required at the moment)
- [x] Documentation
- [x] Automated Tests
- [x] Probably lots more

## Limitations
- [x] As per Android's TableLayout constructing/drawing very large tables takes some time.


## What's new

You can check new implementations of `TableView` on the [release page](https://github.com/Zardozz/FixedHeaderTableLayout/releases).

## Installation

To use this library in your Android project, just add the following dependency into your module's `build.gradle`:

```
dependencies {
implementation 'com.github.zardozz.library:FixedHeaderTableLayout:0.0.0.1'
}
```

## Documentation

Please check out the [project's wiki](https://github.com/Zardozz/FixedHeaderTableLayout/wiki).

## Contributors

Contributions of any kind are welcome!

If you wish to contribute to this project, please refer to our [contributing guide](.github/CONTRIBUTING.md).

## License

```
MIT License
Copyright (c) 2021 Andrew Beck
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
1 change: 1 addition & 0 deletions app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/build
62 changes: 62 additions & 0 deletions app/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
* MIT License
*
* Copyright (c) 2021 Andrew Beck
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

plugins {
id 'com.android.application'
}

android {
compileSdkVersion 29

defaultConfig {
applicationId "com.github.zardozz.fixedheadertablelayout"
minSdkVersion 16
targetSdkVersion 29
versionCode 1
versionName "0.0.0.1"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}

buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}

dependencies {

implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'com.google.android.material:material:1.3.0'
implementation project(path: ':fixedheadertablelayout')
testImplementation 'junit:junit:4.13.2'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
}
21 changes: 21 additions & 0 deletions app/proguard-rules.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
45 changes: 45 additions & 0 deletions app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
~ MIT License
~
~ Copyright (c) 2021 Andrew Beck
~
~ Permission is hereby granted, free of charge, to any person obtaining a copy
~ of this software and associated documentation files (the "Software"), to deal
~ in the Software without restriction, including without limitation the rights
~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
~ copies of the Software, and to permit persons to whom the Software is
~ furnished to do so, subject to the following conditions:
~
~ The above copyright notice and this permission notice shall be included in all
~ copies or substantial portions of the Software.
~
~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
~ SOFTWARE.
-->

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.github.zardozz.fixedheadertablelayoutsample">

<application
android:allowBackup="false"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="false"
android:theme="@style/Theme.FixedHeaderTableLayout">
<activity android:name="com.github.zardozz.fixedheadertablelayoutsample.MainActivity"
>
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>

</manifest>
Loading

0 comments on commit e19f01c

Please sign in to comment.