React 组件命名规范

Source

在 React 项目中,如果希望保持组件命名的一致性,并防止在引入时出现不同名称的问题,可以遵循以下的组件规范:

1、默认导出组件:

  • 所有特殊要求的组件(如页面组件或根组件)应该使用 export default 导出。

  • 这种组件的命名会保持一致,便于其他模块直接导入。

// MyComponent.js  
const MyComponent = () => {
    
        
    return <div>My Component</div>;  
};  

export default MyComponent;  

2、具名导出组件:

其他所有组件应该使用 export const 导出。这样确保在导入该组件时,可以根据需要使用与变量名相同的名称,避免命名冲突和不一致。

// AnotherComponent.js  
export const AnotherComponent = () => {
    
        
    return <div>Another Component</div>;  
};  

3、一致的文件命名:

为了保持良好的可维护性和可读性,文件名应与导出的组件名称一致。建议使用 PascalCase(例如 MyComponent.js、AnotherComponent.js)。

4、组织组件:

可以将组件根据功能或模块组织到不同的文件夹中,确保项目结构清晰。

/src  
└── components  
    ├── MyComponent.js  
    └── AnotherComponent.js  

导入组件:

在需要使用组件的地方,按照具体的规范导入组件时,应确保使用一致的名称。

// App.js  
import MyComponent from './components/MyComponent';  
import {
    
       AnotherComponent } from './components/AnotherComponent';  

const App = () => {
    
        
    return (  
        <div>  
            <MyComponent />  
            <AnotherComponent />  
        </div>  
    );  
};  

export default App;  

通过遵循这些规范,不仅可以提高代码的一致性和可读性,还能减少潜在的错误,使团队协作更加顺畅。