ビュー
関数
useBaseMachinaContext

useBaseMachinaContext

useBaseMachinaContext は、ユーザーコンテキストに関連する情報(ユーザー、プロジェクト、環境)を取得するためのフックです。これらの情報は、一般的にユーザー認証や権限管理などの機能を実装する際に役立ちます。

基本的な使い方

import {
    useBaseMachinaContext,
} from '@basemachina/view';
 
const App = () => {
    ...
    const basemachinaContext = useBaseMachinaContext();
 
    return (
        <div>
            <p>ユーザー名: {basemachinaContext.user.name}</p>
            <p>環境名: {basemachinaContext.environment.name}</p>
            <p>グループ: {basemachinaContext.groups.map(group => group.name).join(', ')}</p>
        </div>
    )
}

詳細なインターフェース

引数

このフックは引数を受け付けません。

戻り値

プロパティ名説明
userオブジェクト現在のユーザーに関する情報を含むオブジェクト。id, email, name, isProjectAdmin, isTenantAdmin のプロパティを含みます。{ id: '1', email: 'user@example.com', name: 'User Name', isProjectAdmin: true, isTenantAdmin: false }
environmentオブジェクト現在の環境に関する情報を含むオブジェクト。id, name のプロパティを含みます。{ id: '1', name: 'Environment Name' }
groupsオブジェクトの配列ユーザーが所属するグループに関する情報を含むオブジェクトの配列。各オブジェクトは id, name のプロパティを含みます。[{ id: '1', name: 'Group1' }, { id: '2', name: 'Group2' }]