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

ProgressField implementation and stories #25103

Merged
merged 8 commits into from
Oct 6, 2022
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
ComboboxField,
InputField,
InputFieldProps,
ProgressField,
RadioGroupField,
SelectField,
SliderField,
Expand All @@ -27,6 +28,7 @@ const AllFields = (
<CheckboxField label="Checkbox" {...props} />
<ComboboxField label="Combo box field" {...props} />
<InputField label="Input field" {...props} />
<ProgressField label="Progress field" {...props} />
<RadioGroupField label="Radio group field" {...props}>
<Radio label="Option one" />
<Radio label="Option two" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Add ProgressField to @fluentui/react-field",
"packageName": "@fluentui/react-field",
"email": "ololubek@microsoft.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Add justify-self styling to Progress styles",
"packageName": "@fluentui/react-progress",
"email": "ololubek@microsoft.com",
"dependentChangeType": "patch"
}
10 changes: 10 additions & 0 deletions packages/react-components/react-field/etc/react-field.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import type { ComponentState } from '@fluentui/react-utilities';
import { ForwardRefComponent } from '@fluentui/react-utilities';
import { Input } from '@fluentui/react-input';
import { Label } from '@fluentui/react-label';
import { Progress } from '@fluentui/react-progress';
import { RadioGroup } from '@fluentui/react-radio';
import * as React_2 from 'react';
import { Select } from '@fluentui/react-select';
Expand Down Expand Up @@ -87,6 +88,15 @@ export const inputFieldClassNames: SlotClassNames<FieldSlots<FieldComponent>>;
// @public (undocumented)
export type InputFieldProps = FieldProps<typeof Input>;

// @public (undocumented)
export const ProgressField: ForwardRefComponent<ProgressFieldProps>;

// @public (undocumented)
export const progressFieldClassNames: SlotClassNames<FieldSlots<FieldComponent>>;

// @public (undocumented)
export type ProgressFieldProps = FieldProps<typeof Progress>;

// @public (undocumented)
export const RadioGroupField: ForwardRefComponent<RadioGroupFieldProps>;

Expand Down
1 change: 1 addition & 0 deletions packages/react-components/react-field/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"@fluentui/react-icons": "^2.0.175",
"@fluentui/react-input": "^9.2.0",
"@fluentui/react-label": "^9.0.6",
"@fluentui/react-progress": "9.0.0-alpha.0",
"@fluentui/react-radio": "^9.0.7",
"@fluentui/react-select": "9.0.0-beta.10",
"@fluentui/react-slider": "^9.0.6",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './components/ProgressField/index';
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import * as React from 'react';
import { render } from '@testing-library/react';
import { isConformant } from '../../common/isConformant';
import { ProgressField } from './ProgressField';

describe('ProgressField', () => {
isConformant({
Component: ProgressField,
displayName: 'ProgressField',
});

// Most functionality is tested by Field.test.tsx, and RadioGroup's tests

it('uses aria-labelledby for the label', () => {
const result = render(<ProgressField label="Test label" />);

const progress = result.getByRole('progressbar');
const label = result.getByText('Test label') as HTMLLabelElement;

expect(label.id).toBeTruthy();
expect(progress.getAttribute('aria-labelledby')).toBe(label.id);
expect(label.htmlFor).toBeFalsy();
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import * as React from 'react';
import { Progress } from '@fluentui/react-progress';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { FieldProps } from '../../Field';
import { getFieldClassNames, renderField_unstable, useFieldStyles_unstable, useField_unstable } from '../../Field';

export type ProgressFieldProps = FieldProps<typeof Progress>;

export const progressFieldClassNames = getFieldClassNames('ProgressField');

export const ProgressField: ForwardRefComponent<ProgressFieldProps> = React.forwardRef((props, ref) => {
const state = useField_unstable(props, ref, {
component: Progress,
classNames: progressFieldClassNames,
labelConnection: 'aria-labelledby',
});
useFieldStyles_unstable(state);
return renderField_unstable(state);
});

ProgressField.displayName = 'ProgressField';
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './ProgressField';
3 changes: 3 additions & 0 deletions packages/react-components/react-field/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ export type { ComboboxFieldProps } from './ComboboxField';
export { InputField, inputFieldClassNames } from './InputField';
export type { InputFieldProps } from './InputField';

export { ProgressField, progressFieldClassNames } from './ProgressField';
export type { ProgressFieldProps } from './ProgressField';

export { RadioGroupField, radioGroupFieldClassNames } from './RadioGroupField';
export type { RadioGroupFieldProps } from './RadioGroupField';

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import type { ProgressFieldProps } from '@fluentui/react-field';
import { ProgressField } from '@fluentui/react-field';

export const Default = (props: Partial<ProgressFieldProps>) => (
<ProgressField
label="Example Progress field"
value={0.75}
validationState="success"
validationMessage="This is a success message"
hint="This is a hint message"
{...props}
/>
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
ProgressField adds a Label, validation message, and hint text to the Progress control.

<!-- Don't allow prettier to collapse code block into single line -->
<!-- prettier-ignore -->
> **⚠️ Preview components are considered unstable:**
>
> ```jsx
>
> import { ProgressField } from '@fluentui/react-components/unstable';
>
> ```
>
> - Features and APIs may change before final release
> - Please contact us if you intend to use this in your product
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { ProgressField } from '@fluentui/react-field';

import descriptionMd from './ProgressFieldDescription.md';

export { Default } from './ProgressFieldDefault.stories';

export default {
title: 'Preview Components/Field/ProgressField',
component: ProgressField,
parameters: {
docs: {
description: {
component: descriptionMd,
},
},
},
};
4 changes: 2 additions & 2 deletions packages/react-components/react-progress/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "@fluentui/react-progress",
"version": "9.0.0-alpha.0",
"private": true,
"description": "Progress component for FluentUI v9",
"main": "lib-commonjs/index.js",
"module": "lib/index.js",
Expand Down Expand Up @@ -48,7 +47,8 @@
"beachball": {
"disallowedChangeTypes": [
"major",
"prerelease"
"minor",
"patch"
]
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const useRootStyles = makeStyles({
root: {
display: 'block',
backgroundColor: tokens.colorNeutralBackground6,
justifySelf: 'stretch',
...shorthands.overflow('hidden'),

'@media screen and (forced-colors: active)': {
Expand Down