Lack of documentation

[ishan1608]

Is there any kind of documentation available for the library. I successfully set it to use in my android app, but the problem is that I don't know which functions are available and how to use them. I have only one option of trying to figure out from the sample project given. Is there a better and faster way to learn how to use this library?

Comments in the sample code explaining the use of the library also won't hurt.

[CesarValiente]

Hi @ishanatmuz,

I think the library is quite well documented regarding the way to use and include it in your projects, with a nice readme and a small sample app that you can follow its steps. Regarding the comments in the code, well there are some comments along the code and on the function headers, maybe is true that we can add more comments, but we have to avoid the problem of adding too much of them, so the code is unreadable.

As soon as I merge the different pull requests we have opened I will include some comments if I find them useful.

Thanks for your suggestion ;-)

[sirvon]

+1 its not really all that well documented as far as the implementation goes. this is my 2nd time trying to implement this lib and it takes quite more time than any other lib i've used

because the available options/configuration, you have to do trial and error to get it right the readme from the creator needs more explanation.

[JlUgia]

Good feedback sirvon, thanks for that. It has been added to maven lately and it's very quick to get it running now. Which are the biggest pain points in your opinion? Also what is the most confusing part of the integration for you? Where did you have the biggest struggles?

There is also some work being done on a new app that gives a bit more of config freedom in order to get into it faster.

[sirvon]

I got everything rocking and rolling now.

But the parts that had me like what the...

Was which option would allow me to leave a bit sticking out like to emulate say media player controls...radio on the bottom.

slidingLayer:shadowDrawable="@drawable/sidebar_shadow"
        slidingLayer:shadowSize="0dp"
        slidingLayer:offsetDistance="115dp"
        slidingLayer:previewOffsetDistance="115dp"
        slidingLayer:stickTo="bottom"
        slidingLayer:changeStateOnTap="false"

I was trying to use the shadow but it wasn't really needed. offsetDistance & previewOffsetDistance are kinda similar so you have to implement either one to really see what fits your use case.

Then I put a background on the Sliding layer itself which eventually ended up covering the whole view, so then I made sure I closed the view in onCreate but I eventually realized the Sliding Layer is just a container and the real views go inside.

But I like this lib I think it'll eventually ended being in the android framework somehow because its super useful for the design and flow of all applications. it is kinda sorta...the notification center.

So the work was worth it.

thanks for the lib!

edit:

maybe graphical show what these components are.. slidingLayer:shadowSize slidingLayer:offsetDistance slidingLayer:previewOffsetDistance

So one can save the compile time and get it right on the first go round. just a thought.