Skip to content

Latest commit

 

History

History
168 lines (130 loc) · 6.97 KB

README.md

File metadata and controls

168 lines (130 loc) · 6.97 KB
Raw

Lassi

Lassi is simplest way to pick media (either image, video, audio or doc)

Lassi Media picker

image       image

Key features

  • Android 12 support
  • Simple implementation
  • Set your own custom styles
  • Filter by particular media type
  • Filter videos by min and max time
  • Enable/disable camera from LassiOption
  • You can open System Default view for file selection by using MediaType.FILE_TYPE_WITH_SYSTEM_VIEW

Usage

Dependencies

  • Step 1. Add the JitPack repository in your project build.gradle:

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

    or

    If Android studio version is Arctic Fox then add it in your settings.gradle:

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

  • Step 2. Add the dependency in your app module build.gradle:

        dependencies {
        ...
        implementation 'com.github.Mindinventory:Lassi:X.X.X'
    }

Implementation

  • Step 1. To open a app color theme view then add Lassi in to your activity class:

            val intent = Lassi(this)
            .with(LassiOption.CAMERA_AND_GALLERY) // choose Option CAMERA or CAMERA_AND_GALLERY
            .setMaxCount(5)
            .setGridSize(3)
            .setMediaType(MediaType.VIDEO) // MediaType : VIDEO IMAGE, AUDIO OR DOC
            .setCompressionRation(10) // compress image for single item selection (can be 0 to 100)
            .setMinTime(15) // for MediaType.VIDEO only
            .setMaxTime(30) // for MediaType.VIDEO only
            .setSupportedFileTypes("mp4", "mkv", "webm", "avi", "flv", "3gp") // Filter by limited media format (Optional)
            .setMinFileSize(100) // Restrict by minimum file size 
            .setMaxFileSize(1024) //  Restrict by maximum file size
            .disableCrop() // to remove crop from the single image selection (crop is enabled by default for single image)
            /*
             * Configuration for  UI
             */
            .setStatusBarColor(R.color.colorPrimaryDark)
            .setToolbarResourceColor(R.color.colorPrimary)
            .setProgressBarColor(R.color.colorAccent)
            .setPlaceHolder(R.drawable.ic_image_placeholder)
            .setErrorDrawable(R.drawable.ic_image_placeholder)
            .setSelectionDrawable(R.drawable.ic_checked_media)
            .setCropType(CropImageView.CropShape.RECTANGLE) // choose shape for cropping after capturing an image from camera (for MediaType.IMAGE only)
            .setCropAspectRatio(1, 1) // define crop aspect ratio for cropping after capturing an image from camera (for MediaType.IMAGE only)
            .enableFlip() // Enable flip image option while image cropping (for MediaType.IMAGE only)
            .enableRotate() // Enable rotate image option while image cropping (for MediaType.IMAGE only)
            .enableActualCircleCrop() // Enable actual circular crop (only for MediaType.Image and CropImageView.CropShape.OVAL)
            .build()
         receiveData.launch(intent)

OR To open a system default view then add Lassi in to your activity class:

            val intent = Lassi(this)
                .setMediaType(MediaType.FILE_TYPE_WITH_SYSTEM_VIEW)
                .setSupportedFileTypes(
                "jpg", "jpeg", "png", "webp", "gif", "mp4", "mkv", "webm", "avi", "flv", "3gp",
                "pdf", "odt", "doc", "docs", "docx", "txt", "ppt", "pptx", "rtf", "xlsx", "xls"
                )  // Filter by required media format (Mandatory)
                .build()
            receiveData.launch(intent)

  • Step 2. Get Lassi result in ActivityResultCallback lambda function.

        private val receiveData =
            registerForActivityResult(ActivityResultContracts.StartActivityForResult()) {
                if (it.resultCode == Activity.RESULT_OK) {
                    val selectedMedia =
                        it.data?.getSerializableExtra(KeyUtils.SELECTED_MEDIA) as ArrayList<MiMedia>
                    if (!selectedMedia.isNullOrEmpty()) {
                        ivEmpty.isVisible = selectedMedia.isEmpty()
                        selectedMediaAdapter.setList(selectedMedia)
                    }
                }
            }

Document access permission note

If Android device SDK is >= 30 and wants to access document (only for choose the non media file) then add android.permission.MANAGE_EXTERNAL_STORAGE permission in your app otherwise library won't allow to access documents. Kindly check sample app for more detail. If you don't want to give Manage External Storage permission and wants to get files with system default view then You can use OR option from Step 1 and give required file type of document.

MediaType.FILE_TYPE_WITH_SYSTEM_VIEW (for System Default View)

Using this MediaType you can choose multiple files from system default view. You can't set max count limit for file choose. Give file type into setSupportedFileTypes and you can choose only those types of file from system view.

Guideline for contributors

Contribution towards our repository is always welcome, we request contributors to create a pull request to the develop branch only.

Guideline to report an issue/feature request

It would be great for us if the reporter can share the below things to understand the root cause of the issue.

  • Library version
  • Code snippet
  • Logs if applicable
  • Device specification like (Manufacturer, OS version, etc)
  • Screenshot/video with steps to reproduce the issue

Requirements

  • minSdkVersion >= 19
  • Androidx

Library used

ProGaurd rules

-dontwarn com.bumptech.glide.**

LICENSE!

Lassi is MIT-licensed.

Let us know!

We’d be really happy if you send us links to your projects where you use our component. Just send an email to [email protected] And do let us know if you have any questions or suggestion regarding our work.

app development