Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(react): add Flag component #77

Merged
merged 1 commit into from
Mar 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@
"react-dom": "^18.2.0",
"rollup": "^3.5.0",
"rollup-plugin-dts": "^5.0.0",
"rollup-plugin-peer-deps-external": "^2.2.4",
"rollup-plugin-postcss": "^4.0.2",
"rollup-plugin-terser": "^7.0.2",
"sass": "^1.56.1",
Expand Down
55 changes: 55 additions & 0 deletions packages/react/src/components/Flag/Flag.stories.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import {ArgsTable, Source, Story, Canvas, Meta} from '@storybook/addon-docs';
import Flag from './Flag';
import dedent from 'ts-dedent';
import StoryConfig from '../../../.storybook/story-config.ts';

export const meta = {
component: Flag,
title: StoryConfig.Flag.hierarchy
};

<Meta title={meta.title} component={meta.component} />

export const Template = args => <Flag {...args} />;

# Flag

- [Overview](#overview)
- [Props](#props)
- [Usage](#usage)

## Overview

Flag can be used to show the flag of the country for the provided country code.

<Canvas>
<Story name="Overview" args={{
title: "Sri Lanka",
countryCode: "LK"
}}>
{Template.bind({})}
</Story>
</Canvas>

## Props
<ArgsTable story="Overview" />

## Usage

Import and use the `Flag` component in your components as follows.

<Source
language="jsx"
dark
format
code={dedent`
import Flag from '@oxygen-ui/react/Flag';\n
function Demo() {
return (
<Flag
title="Sri Lanka"
countryCode="LK"
/>
);
}`}
/>
50 changes: 50 additions & 0 deletions packages/react/src/components/Flag/Flag.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import {Typography} from '@mui/material';
import {FC, ReactElement} from 'react';
import WorldFlag from 'react-world-flags';
import {WithWrapperProps} from '../../models';
import {composeComponentDisplayName} from '../../utils';

export interface FlagsProps extends React.HTMLAttributes<HTMLElement & SVGElement> {
/**
* The two-letter/three-letter/three-digit country code of the flag.
*/
countryCode: string;
/**
* The height of the flag.
*/
height?: string;
}

const COMPONENT_NAME: string = 'Flag';

const Flag: FC<FlagsProps> & WithWrapperProps = (props: FlagsProps): ReactElement => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT about making this component name into something specific like CountryFlag because in the future we might need to have a flag icon in our icon library and it would be inconvenient to rename when importing or locating the component upon searching.

or we can introduce a generic flag icon as a fallback when the countryCode doesnt match?

E.g. - https://mui.com/material-ui/material-icons/?query=flag&selected=Flag

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a valid concern. Let's rename Flag to CountryFlag in another PR.

const {countryCode, height, ...rest} = props;

return <WorldFlag code={countryCode} height={height} fallback={<Typography>{countryCode}</Typography>} {...rest} />;
};

Flag.displayName = composeComponentDisplayName(COMPONENT_NAME);
Flag.muiName = COMPONENT_NAME;
Flag.defaultProps = {
height: '16',
};

export default Flag;
32 changes: 32 additions & 0 deletions packages/react/src/components/Flag/__tests__/Flag.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/**
* Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import {render} from '@unit-testing';
import Flag from '../Flag';

describe('Flag', () => {
it('should render successfully', () => {
const {baseElement} = render(<Flag countryCode="LK" />);
expect(baseElement).toBeTruthy();
});

it('should match the snapshot', () => {
const {baseElement} = render(<Flag countryCode="LK" />);
expect(baseElement).toMatchSnapshot();
});
});

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions packages/react/src/components/Flag/flag.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/**
* Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

.oxygen-flags {
/** Add Styles */
}
20 changes: 20 additions & 0 deletions packages/react/src/components/Flag/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/**
* Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

export {default} from './Flag';
export type {FlagsProps} from './Flag';
44 changes: 21 additions & 23 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.