Note:

Using CoreOptions is optional. If you do not provide any options, default options will be used. If you provide a localDataClass, it must extend BaseLocalData.

Example LocalData class:

object YourLocalData : BaseLocalData() {

    suspend fun someFunctions() : Resource<SomeModel> {
        // This method utilizes a core function from iCore to perform a database operation
        return databaseOperation({
            getStringData("some_data")
        })
    }
}

Basic Usage

BaseActivity

Create your activities by extending BaseActivity:

class YourActivity : BaseActivity<ActivityYourBinding, YourViewModel>() {

    override fun initViewBinding() = ActivityYourBinding.inflate(layoutInflater)
    override val viewModel: YourViewModel by lazy {
        ViewModelProvider(this)[YourViewModel::class.java]
    }

    override fun init() {
        super.init()
        // Additional initialization here
    }
}

Note: If your activity or fragment does not require a ViewModel, you can use Nothing in place of YourViewModel. For example:

class YourActivity : BaseActivity<ActivityYourBinding, Nothing>() {

    override fun initViewBinding() = ActivityYourBinding.inflate(layoutInflater)

    override fun init() {
        super.init()
        // Additional initialization here
    }
}

BaseFragment

Create your fragments by extending BaseFragment:

class YourFragment : BaseFragment<FragmentYourBinding, YourViewModel>() {
    override fun initViewBinding() = FragmentYourBinding.inflate(layoutInflater)
    override val viewModel: YourViewModel by lazy {
        // currentActivity is a property provided by BaseFragment from iCore
        ViewModelProvider(currentActivity)[YourViewModel::class.java]
    }

    override fun init() {
        super.init()
        // Set the LifecycleOwner for LiveData observation
        binding.lifecycleOwner = this

        // If needed, set the loading view to be shown during loading states
        loadingView = binding.progressBar

        // If needed, set the back button to navigate up when pressed
        backButton = binding.yourBackButtonImageView
    }

    override fun initObservers() {
        super.initObservers()
        // This is an extension function provided by iCore to observe LiveData
        observe(viewModel.navigateToSomewhere) {
            if (it) {
                // This is an extension function provided by iCore to navigation
                navigateToActivity(
                    SomeOtherActivity::class.java, // Required
                    finishActivity = true, // Default is false
                    bundle = null // Default is null
                )
            }
        }
    }
}

BaseViewModel

Create your ViewModels by extending BaseViewModel:

class YourViewModel(
    private val repository: YourRepository
) : BaseViewModel() {

    private val _navigateToMain = MutableLiveData<Boolean>()
    val navigateToMain: MutableLiveData<Boolean>
        get() = _navigateToMain

    fun login() {
        collectData(
            {
                repository.login(SomeRequestModel()))
            }, successAction = {
                showSuccessSnackbar(R.string.login_success)
                _navigateToMain.value = true
            }
        )
    }

    fun sampleFunction() {
        collectData(
            // Required: The function to be executed to fetch data from the repository
            operation = {
                repository.sampleFunction()
            },
            // Optional: Action to perform when the data fetching is successful
            successAction = {
                // Handle the successful response
            },
            // Optional: Action to perform when there is an error in fetching data
            errorAction = { message, errorBody ->
                // Handle the error
            },
            // Optional: Action to perform while the data is being loaded
            loadingAction = {
                // Show loading state
            },
            // Optional: Type of Snackbar to display for the error, success, etc.
            stateType = StateType.DEFAULT,
            // Optional: Text to display on the Snackbar action button
            actionText = "Action",
            // Optional: Action to perform when the Snackbar action button is clicked
            snackBarAction = {
                // Perform action when Snackbar action is triggered
            },
            // Optional: Lambda to determine whether the error message should be shown
            shouldShowError = { message, errorBody ->
                // Return true to show the error, false to suppress it
                message != "Specific message to suppress"
            }
        )
    }
}

BaseAdapter

Adapter Class

Create your adapter by extending BaseAdapter:

class YourAdapter : BaseAdapter<YourModel, ItemYourBinding>(ItemYourBinding::inflate) {

    override fun bind(holder: BaseViewHolder, item: YourModel, context: Context) {
        holder.apply {
            binding.tvYourTextView.text = item.someProperty
        }
    }
}

Activity or Fragment

Use your adapter in an Activity or Fragment:

val adapter = YourAdapter()
binding.recyclerView.adapter = adapter
adapter.submitList(yourList)

adapter.setOnItemClickListener { item ->
    // Do something with item
}

// `view` is the specific View within the item layout that was clicked.
// This allows you to perform actions or access properties of the clicked View directly.
adapter.setOnItemViewClickListener { item, view ->
    when (view.id) {
        R.id.someId -> //Some View clicked
        else -> //Root View clicked
    } 
}

Retrofit Setup

To create a Retrofit instance using iCore, follow these steps:

Network Module

Initialize Retrofit in a singleton object or a class. You can add headers if needed.

object RetrofitInstance {

    private val headers = mapOf("SomeKey" to "SomeValue")

    val retrofit: Retrofit by lazy {
        CoreNetwork.provideRetrofit("https://yourapi.baseurl.com/", headers)
    }
}

Remote Data

Create a remote data source class by extending BaseRemoteData:

class SomeRemoteData(private val service: SomeService) : BaseRemoteData {

    suspend fun login(user: SomeRequestModel): Resource<SomeResponseModel> {
        return responseHandler({ service.login(user) })
    }

    // If needed, you can add additional actions or convert the response body to the desired entity.
    suspend fun login(user: SomeRequestModel): Resource<SomeResponseConvertedEntity> {
        return responseHandler({ service.login(user) }, entityConverter = { response ->
            // Here you can convert the response to the desired entity.
        }, doThenOnIO = { response ->
            // Here you can perform additional operations in the IO thread.
        })
    }
}

Repository

Create a repository class by extending BaseRepository:

class SomeRepository(private val remoteData: SomeRemoteData) : BaseRepository {

    suspend fun login(user: SomeRequestModel): Flow<Resource<SomeResponseModel>> {
        return emitResult({ remoteData.login(user) })
    }

    // If needed, you can add additional actions.
    suspend fun login(user: SomeRequestModel): Flow<Resource<SomeResponseModel>> {
        return emitResult({ remoteData.login(user) }, doThenOnMain = { resource ->
            // Here you can perform additional operations on the Main Thread.
        })
    }
}

Extension Functions

Example Usages

iCore provides various useful extension functions. Here are a few examples:

Endless Scroll

// Adds an endless scroll listener to the RecyclerView, enabling infinite scrolling and pull-to-refresh functionality.
binding.recyclerView.addOnEndlessScrollListener(
    // Optional: The minimum number of items below your current scroll position before loading more (default is 5).
    visibleThreshold = 10,
    // Optional: FloatingActionButton used to scroll the list back to the top.
    returnToTopFab = binding.fabReturnTop,
    // Optional: SwipeRefreshLayout that handles the pull-to-refresh gesture.
    swipeRefreshLayout = binding.swipeRefreshLayout,
    // Required: Callback invoked when more data needs to be loaded.
    onLoadMore = { page, totalItemsCount, view ->
        // Update the current page number.
        currentPage = page
        // Fetch more data based on the current page.
        viewModel.getData(currentPage)
    },
    // Optional: Callback invoked when a refresh is requested.
    onRefresh = {
        // Reset to the first page.
        currentPage = 0
        // Fetch the initial set of data.
        viewModel.getData(currentPage)
    }
)

Observing LiveData

observe(viewModel.someLiveData) {
    // Handle the observed data
}

Theme Selection

currentActivity.showThemeChoiceDialog()

Language Selection

private val languages = mapOf(
    "English" to "en",
    "Türkçe" to "tr"
)

currentActivity.showLanguageChoiceDialog(languages)

Loading Images

myImageView.loadImage("ImageUrl, ImageUri or ImageSource")

Custom Dialog

 showCustomDialog(
    // Required: The title of the dialog.
    title = "Title",
    // Required: The message to display in the dialog.
    message = "Message",
    // Optional: The text for the positive button (default is "Okay").
    positiveButtonText = "Positive Button",
    // Optional: The text for the negative button (default is "Cancel").
    negativeButtonText = "Negative Button",
    // Optional: The type of dialog to display (SUCCESS, ERROR, WARNING, INFO, or