Feedback on prop naming (useKeycloak and useEphemeralStorage)

[kittaakos]

Hi There,

I wanted to share some feedback regarding the naming conventions for props in the framework, particularly in relation to the use prefix.

I believe using the use prefix for props can be somewhat misleading in the context of React. This is primarily because it collides with React's naming convention for hooks. Although I haven't encountered any actual issues yet where a prop is mistakenly identified as a React hook by the linter, this can easily lead to confusion for developers. When we see the use prefix, we naturally expect that what follows is a hook.

Additionally, I noticed a potential name collision when using it with the official Keycloak provider. Here’s an example:

import { useKeycloak } from '@react-keycloak/web'

const { useKeycloak } = useTheiaCloudConfig()
const { initialized, keycloak } = useKeycloak() // :( ohh

In this case, the useKeycloak from the provider conflicts with the useKeycloak defined in TheiaCloudConfig.

Maybe you can consider these as you evolve the framework to 2.0.

Thank you for your contributions to open-source ❤️