FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(Spinner): Add Spinner to experimental by tlabaj · Pull Request #2858 · patternfly/patternfly-react · GitHub

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .js  (2) .md  (1) .snap  (1) .ts  (5) .tsx  (3) All 5 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
        • Spinner.md
        • Spinner.test.tsx
        • Spinner.tsx
          • Spinner.test.tsx.snap
        • index.ts
      • index.ts
        • spinner.spec.ts
        • Demos.ts
            • SpinnerDemo.tsx
          • index.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: 'Spinner'
cssPrefix: 'pf-c-spinner'
typescript: true
propComponents: ['Spinner']
section: 'experimental'
---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

For this to show up properly on -org, we are using a new stage: 'early' in the frontmatter. I'll address this in a follow-up PR.


import { Spinner } from '@patternfly/react-core/dist/esm/experimental';
import { Alert } from '@patternfly/react-core';

<Alert variant="danger" title="Warning">
Use this component at your own risk, it's currently under development and is subject
to change.
</Alert>

## Spinner

```js
import React from 'react';
import { Spinner } from '@patternfly/react-core/dist/esm/experimental';

SpinnerSimple = () => (<Spinner/>);
```

# Spinner size variations

```js
import React from 'react';
import { Spinner } from '@patternfly/react-core/dist/esm/experimental';

SpinnerSizeVariations = () => (
<React.Fragment>
<Spinner size="sm"/>
<Spinner size="md"/>
<Spinner size="lg"/>
<Spinner size="xl"/>
</React.Fragment>
);
```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import * as React from 'react';
import { shallow } from 'enzyme';
import { Spinner } from './Spinner';

test('simple spinner', () => {
const view = shallow(<Spinner/>);
expect(view).toMatchSnapshot();
});

test('small spinner', () => {
const view = shallow(<Spinner/>);
expect(view).toMatchSnapshot();
});

test('medium spinner', () => {
const view = shallow(<Spinner/>);
expect(view).toMatchSnapshot();
});

test('large spinner', () => {
const view = shallow(<Spinner/>);
expect(view).toMatchSnapshot();
});

test('extra large spinner', () => {
const view = shallow(<Spinner/>);
expect(view).toMatchSnapshot();
});
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import * as React from 'react';
import styles from '@patternfly/react-styles/css/components/Spinner/spinner';
import { css, getModifier } from '@patternfly/react-styles';
import { Omit } from '../../../helpers/typeUtils';

export enum spinnerSize {
sm = 'sm',
md = 'md',
lg = 'lg',
xl = 'xl'
}

export interface SpinnerProps
extends Omit<React.HTMLProps<HTMLSpanElement>, 'size'> {
/** Additional classes added to the Spinner. */
className?: string;
/** Size variant of progress. */
size?: 'sm' | 'md' | 'lg' | 'xl';
/** Aria value text */
'aria-valuetext'?: string;
}

export const Spinner: React.FunctionComponent<SpinnerProps> = ({
className = '',
size = 'xl',
'aria-valuetext': ariaValueText = 'Loading...',
...props
}) => (
<span
className={css(styles.spinner, getModifier(styles, size))}
role="progressbar"
aria-valuetext={ariaValueText}
{...props}
>
<span className={css(styles.spinnerClipper)} />
<span className={css(styles.spinnerLeadBall)} />
<span className={css(styles.spinnerTailBall)} />
</span>
);
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`extra large spinner 1`] = `
<span
aria-valuetext="Loading..."
className="pf-c-spinner pf-m-xl"
role="progressbar"
>
<span
className="pf-c-spinner__clipper"
/>
<span
className="pf-c-spinner__lead-ball"
/>
<span
className="pf-c-spinner__tail-ball"
/>
</span>
`;

exports[`large spinner 1`] = `
<span
aria-valuetext="Loading..."
className="pf-c-spinner pf-m-xl"
role="progressbar"
>
<span
className="pf-c-spinner__clipper"
/>
<span
className="pf-c-spinner__lead-ball"
/>
<span
className="pf-c-spinner__tail-ball"
/>
</span>
`;

exports[`medium spinner 1`] = `
<span
aria-valuetext="Loading..."
className="pf-c-spinner pf-m-xl"
role="progressbar"
>
<span
className="pf-c-spinner__clipper"
/>
<span
className="pf-c-spinner__lead-ball"
/>
<span
className="pf-c-spinner__tail-ball"
/>
</span>
`;

exports[`simple spinner 1`] = `
<span
aria-valuetext="Loading..."
className="pf-c-spinner pf-m-xl"
role="progressbar"
>
<span
className="pf-c-spinner__clipper"
/>
<span
className="pf-c-spinner__lead-ball"
/>
<span
className="pf-c-spinner__tail-ball"
/>
</span>
`;

exports[`small spinner 1`] = `
<span
aria-valuetext="Loading..."
className="pf-c-spinner pf-m-xl"
role="progressbar"
>
<span
className="pf-c-spinner__clipper"
/>
<span
className="pf-c-spinner__lead-ball"
/>
<span
className="pf-c-spinner__tail-ball"
/>
</span>
`;
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './Spinner';
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './Button';
export * from './Badge';
export * from './Drawer';
export * from './Spinner';
3 changes: 2 additions & 1 deletion packages/patternfly-4/react-docs/.eslintrc.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ module.exports = {
'@patternfly-safe/react-tokens',
'@patternfly/react-topology',
'@patternfly-safe/patternfly/patternfly.css',
'@patternfly-safe/patternfly/components/Drawer/drawer.css'
'@patternfly-safe/patternfly/components/Drawer/drawer.css',
'@patternfly-safe/patternfly/components/Spinner/spinner.css'
]
}
],
Expand Down
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ import './static/base.css'; // eslint-disable-line import/no-unresolved
import '@patternfly-safe/patternfly/patternfly.css';
// Add experimental styles here and in eslintrc.js for the moment. Once they have been moved out of experimental remove the CSS here and in .eslintrc.js
import '@patternfly-safe/patternfly/components/Drawer/drawer.css';
import '@patternfly-safe/patternfly/components/Spinner/spinner.css';
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
describe('Spinner Demo Test', () => {
it('Navigate to demo section', () => {
cy.visit('http://localhost:3000/');
cy.get('#spinner-demo-nav-item-link').click();
cy.url().should('eq', 'http://localhost:3000/spinner-demo-nav-link');
});
it('Verify small spinner', () => {
cy.get('.pf-c-spinner.pf-m-sm').should('exist');
});
it('Verify medium spinner', () => {
cy.get('.pf-c-spinner.pf-m-md').should('exist');
});
it('Verify large spinner', () => {
cy.get('.pf-c-spinner.pf-m-lg').should('exist');
});

it('Verify extra large spinner', () => {
cy.get('.pf-c-spinner.pf-m-xl').should('exist');
});
});
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,11 @@ export const Demos: DemoInterface[] = [
name: 'Select Demo',
componentType: Examples.SelectDemo
},
{
id: 'spinner-demo',
name: 'Spinner Demo',
componentType: Examples.SpinnerDemo
},
{
id: 'split-demo',
name: 'Split Demo',
Expand Down
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import React from 'react';
import { Spinner, SpinnerProps } from '@patternfly/react-core/dist/esm/experimental';

export class SpinnerDemo extends React.Component<SpinnerProps> {

componentDidMount() {
window.scrollTo(0, 0);
}

render() {
return (
<React.Fragment>
<Spinner/>
<span>
<div>Size variations</div>
<Spinner size="sm"/>
<Spinner size="md"/>
<Spinner size="lg"/>
<Spinner size="xl"/>
</span>
</React.Fragment>
);
}
}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ export * from './PieChartDemo/PieOrangeDemo';
export * from './PopoverDemo/PopoverDemo';
export * from './ProgressDemo/ProgressDemo';
export * from './RadioDemo/RadioDemo';
export * from './SelectDemo/SelectDemo';
export * from './SpinnerDemo/SpinnerDemo';
export * from './SplitDemo/SplitDemo';
export * from './StackChartDemo/StackBlueDemo';
export * from './StackChartDemo/StackGoldBottomLegendDemo';
Expand All @@ -91,5 +93,4 @@ export * from './TextInputDemo/TextInputDemo';
export * from './TitleDemo/TitleDemo';
export * from './ToolbarDemo/ToolbarDemo';
export * from './TooltipDemo/TooltipDemo';
export * from './WizardDemo/WizardDemo';
export * from './SelectDemo/SelectDemo';
export * from './WizardDemo/WizardDemo';

Back | FazBrowse Home | New Git URL