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(Tabs): updated props and markup #578

Merged
merged 3 commits into from
Feb 27, 2024
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 @@ -23,6 +23,7 @@ export const warningRules = [
"react-dropzone-warn-upgrade",
"table-warn-actionsColumn",
"table-warn-thExpandType",
"tabs-update-markup",
"tabs-warn-children-type-changed",
"tooltip-warn-triggerRef-may-be-required",
"wizard-warn-button-order",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### tabs-renamed-isSecondary-prop [(#10044)](https://github.com/patternfly/patternfly-react/pull/10044)

The `isSecondary` prop for Tabs has been renamed to \`isSubtab\`.

#### Examples

In:

```jsx
%inputExample%
```

Out:

```jsx
%outputExample%
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
const ruleTester = require("../../ruletester");
import * as rule from "./tabs-renamed-isSecondary-prop";

ruleTester.run("tabs-renamed-isSecondary-prop", rule, {
valid: [
{
code: `<Tabs isSecondary />`,
},
{
code: `import { Tabs } from '@patternfly/react-core'; <Tabs someOtherProp />`,
},
],
invalid: [
{
code: `import { Tabs } from '@patternfly/react-core'; <Tabs isSecondary />`,
output: `import { Tabs } from '@patternfly/react-core'; <Tabs isSubtab />`,
errors: [
{
message: `The \`isSecondary\` prop for Tabs has been renamed to \`isSubtab\`.`,
type: "JSXOpeningElement",
},
],
},
],
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { renameProps } from "../../helpers";

// https://github.com/patternfly/patternfly-react/pull/10044
module.exports = {
meta: { fixable: "code" },
create: renameProps({
Tabs: {
isSecondary: {
newName: "isSubtab",
message:
"The `isSecondary` prop for Tabs has been renamed to `isSubtab`.",
},
},
}),
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { Tabs } from "@patternfly/react-core";

export const TabsRenamedIsSecondaryPropInput = () => <Tabs isSecondary />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { Tabs } from "@patternfly/react-core";

export const TabsRenamedIsSecondaryPropInput = () => <Tabs isSubtab />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### tabs-replace-variant-light300 [(#9930)](https://github.com/patternfly/patternfly-react/pull/9930) [(#10044)](https://github.com/patternfly/patternfly-react/pull/10044)

The "light300" value for the `variant` prop on Tabs has been replaced with the "secondary" value.

#### Examples

In:

```jsx
%inputExample%
```

Out:

```jsx
%outputExample%
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
const ruleTester = require("../../ruletester");
import * as rule from "./tabs-replace-variant-light300";

ruleTester.run("tabs-replace-variant-light300", rule, {
valid: [
{
code: `<Tabs variant="light300" />`,
},
{
code: `import { Tabs } from '@patternfly/react-core'; <Tabs variant="secondary" />`,
},
],
invalid: [
{
code: `import { Tabs } from '@patternfly/react-core'; <Tabs variant="light300" />`,
output: `import { Tabs } from '@patternfly/react-core'; <Tabs variant="secondary" />`,
errors: [
{
message: `The "light300" value for the \`variant\` prop on Tabs has been replaced with the "secondary" value.`,
type: "JSXOpeningElement",
},
],
},
],
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import { getFromPackage } from "../../helpers";

// https://github.com/patternfly/patternfly-react/pull/9930
// https://github.com/patternfly/patternfly-react/pull/10044
module.exports = {
meta: { fixable: "code" },
create: function (context: {
report: (arg0: {
node: any;
message: string;
fix(fixer: any): any;
}) => void;
}) {
const { imports, exports } = getFromPackage(
context,
"@patternfly/react-core"
);

const tabsImport = imports.find(
(specifier: { imported: { name: string }; local: { name: string } }) =>
specifier.imported.name === "Tabs"
);

return !tabsImport
? {}
: {
JSXOpeningElement(node: { name: { name: any }; attributes: any[] }) {
if (node.name.name === tabsImport.local.name) {
const attribute = node.attributes.find(
(attr: { name: { name: string }; value: { value: string } }) =>
attr.name?.name === "variant"
);
if (attribute && attribute.value.value === "light300") {
context.report({
node,
message:
'The "light300" value for the `variant` prop on Tabs has been replaced with the "secondary" value.',
fix(fixer: {
replaceText: (arg0: any, arg1: string) => any;
}) {
return fixer.replaceText(attribute.value, '"secondary"');
},
});
}
}
},
};
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { Tabs } from "@patternfly/react-core";

export const TabsReplaceVariantLight300Input = () => (
<Tabs variant='light300' />
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { Tabs } from "@patternfly/react-core";

export const TabsReplaceVariantLight300Input = () => (
<Tabs variant="secondary" />
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### tabs-update-markup [(#10044)](https://github.com/patternfly/patternfly-react/pull/10044)

The markup for the Tabs scroll buttons have been updated in the following ways:

- Replaced the native `button` HTML element internally with our Button components
- Added a wrapper `div` around them
- Removed styling when the `isSubtab` (previously `isSecondary`) prop is true
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
const ruleTester = require("../../ruletester");
import * as rule from "./tabs-update-markup";

ruleTester.run("tabs-update-markup", rule, {
valid: [
{
code: `import { Tabs } from 'someOtherPackage';`,
},
],
invalid: [
{
code: `import { Tabs } from '@patternfly/react-core';`,
output: `import { Tabs } from '@patternfly/react-core';`,
errors: [
{
message: `The markup for the Tabs scroll buttons has been updated. They are now rendered with a div wrapper, use our Button component, and no longer have adjusted styling when the \`isSubtab\` prop is true.`,
type: "ImportDeclaration",
},
],
},
],
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { getFromPackage } from "../../helpers";

// https://github.com/patternfly/patternfly-react/pull/10044
module.exports = {
meta: { fixable: "code" },
create: function (context: {
report: (arg0: {
node: any;
message: string;
fix?(fixer: any): any;
}) => void;
}) {
const { imports, exports } = getFromPackage(
context,
"@patternfly/react-core"
);

const tabsImport = imports.find(
(specifier: { imported: { name: string } }) =>
specifier.imported.name === "Tabs"
);

return !tabsImport
? {}
: {
ImportDeclaration(node: {
specifiers: { imported: { name: string } }[];
}) {
if (
node.specifiers.find(
(specifier: { imported: { name: string } }) =>
specifier.imported.name === tabsImport.imported.name
)
) {
context.report({
node,
message:
"The markup for the Tabs scroll buttons has been updated. They are now rendered with a div wrapper, use our Button component, and no longer have adjusted styling when the `isSubtab` prop is true.",
});
}
},
};
},
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { Tabs } from "@patternfly/react-core";

export const TabsUpdateMarkupInput = () => <Tabs />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { Tabs } from "@patternfly/react-core";

export const TabsUpdateMarkupInput = () => <Tabs />;
Loading