Updated Git documentation. #983

MBudreviciusBentley · 2024-08-26T13:30:58Z

Changes

Updated packages under ui directory README.md and package.jsonfiles.

Testing

N/A

CLAassistant · 2024-08-26T13:31:04Z

All committers have signed the CLA.

GerardasB · 2024-09-03T07:23:52Z

ui/core-react/README.md

+import {
+  ContextMenu,
+  ContextMenuItem,
+  ContextSubMenu,
+} from "@itwin/core-react";
+
+export const Basic: Story = {
+  render: (props) => {
+    return (
+      <ContextMenu {...props}>
+        <ContextSubMenu label="Label 1" id="1">
+          <ContextMenuItem>Label 1</ContextMenuItem>
+        </ContextSubMenu>
+      </ContextMenu>
+    );
+  },
+};
+


Suggested change

import {

ContextMenu,

ContextMenuItem,

ContextSubMenu,

} from "@itwin/core-react";

export const Basic: Story = {

render: (props) => {

return (

<ContextMenu {...props}>

<ContextSubMenu label="Label 1" id="1">

<ContextMenuItem>Label 1</ContextMenuItem>

</ContextSubMenu>

</ContextMenu>

);

},

};

import {

ContextMenu,

ContextMenuItem,

} from "@itwin/core-react";

export function App() {

return (

<ContextMenu>

<ContextMenuItem>Item 1</ContextMenuItem>

</ContextMenu>

);

};

Let's avoid storybook-specific types.

I think we might need separate setup and usage sections for each package...

GerardasB · 2024-09-03T07:24:36Z

ui/core-react/README.md


-See the [iTwin.js](https://www.itwinjs.org/learning/ui/core/) documentation for more information.
+To get started with React components from the `@itwin/core-react` package, simply import the necessary components and utilities:


Suggested change

To get started with React components from the `@itwin/core-react` package, simply import the necessary components and utilities:

To get started with the `@itwin/components-react` package, simply import the necessary components and utilities:

GerardasB · 2024-09-03T07:25:03Z

ui/imodel-components-react/README.md

-## Documentation
+## Usage
+
+To get started with React components from the `@itwin/imodel-components-react` package, simply import the necessary components and utilities:


Suggested change

To get started with React components from the `@itwin/imodel-components-react` package, simply import the necessary components and utilities:

To get started with the `@itwin/imodel-components-react` package, simply import the necessary components and utilities:

GerardasB · 2024-09-03T07:25:38Z

ui/imodel-components-react/README.md

+};
+```
+
+For more details, check out the [@itwin/imodel-components-react](https://www.itwinjs.org/reference/imodel-components-react/).


Suggested change

For more details, check out the [@itwin/imodel-components-react](https://www.itwinjs.org/reference/imodel-components-react/).

For more details, check out the [@itwin/imodel-components-react documentation](https://www.itwinjs.org/reference/imodel-components-react/).

GerardasB · 2024-09-03T07:30:07Z

ui/imodel-components-react/package.json

@@ -1,7 +1,7 @@
 {
  "name": "@itwin/imodel-components-react",
  "version": "4.17.0-dev.0",
-  "description": "iTwin.js UI IModel Components",
+  "description": "A react component library for iTwin.js UI IModel Components",


Suggested change

"description": "A react component library for iTwin.js UI IModel Components",

"description": "A react component library of iTwin.js UI iModel components",

GerardasB · 2024-09-03T07:41:02Z

ui/components-react/README.md

+import {
+  PropertyDescription,
+  StandardTypeNames,
+} from "@itwin/appui-abstract";
+import {
+  PropertyFilterRuleGroupOperator,
+  PropertyFilter,
+} from "@itwin/components-react";
+
+function createProperties(): PropertyDescription {
+  return new PropertyDescription({
+    name: "string-prop",
+    displayLabel: "String Property",
+    typename: StandardTypeNames.String,
+  });
+}
+
+function createInitialFilter(): PropertyFilter {
+  const property = createProperty();
+  return {
+    operator: PropertyFilterRuleGroupOperator.Or,
+    rules: [
+      {
+        property: property,
+        operator: "like",
+      },
+    ],
+  };
+}


Update this snippet to pass in some minimal data/props to PropertyFilterBuilderRenderer.

GerardasB · 2024-09-03T07:51:59Z

ui/appui-react/README.md

+}
+```
+
+For more details, check out the [@itwin/appui-react documentation](https://www.itwinjs.org/reference/appui-react/).


Suggested change

For more details, check out the [@itwin/appui-react documentation](https://www.itwinjs.org/reference/appui-react/).

For more details, check out [Get Started](https://www.itwinjs.org/ui/appui/get-started/) guide or [@itwin/appui-react documentation](https://www.itwinjs.org/reference/appui-react/).

GerardasB · 2024-09-03T07:57:31Z

ui/core-react/package.json

@@ -1,7 +1,7 @@
 {
  "name": "@itwin/core-react",
  "version": "4.17.0-dev.0",
-  "description": "iTwin.js UI core components",
+  "description": "A react component library for iTwin.js UI general purpose components",


Suggested change

"description": "A react component library for iTwin.js UI general purpose components",

"description": "A react component library of iTwin.js UI general purpose components",

GerardasB · 2024-09-03T08:04:00Z

ui/imodel-components-react/README.md

+```tsx
+import { BaseSolarDataProvider } from "@itwin/imodel-components-react";
+
+export const Basic: Story = {


Let's avoid storybook specific snippets.

GerardasB · 2024-09-03T08:04:30Z

ui/components-react/package.json

@@ -1,7 +1,7 @@
 {
  "name": "@itwin/components-react",
  "version": "4.17.0-dev.0",
-  "description": "iTwin.js UI complex components",
+  "description": "A react component library for iTwin.js UI data-oriented components",


Suggested change

"description": "A react component library for iTwin.js UI data-oriented components",

"description": "A react component library of iTwin.js UI data-oriented components",

Updated Git documentation.

462b8bc

MBudreviciusBentley requested a review from a team as a code owner August 26, 2024 13:30

MBudreviciusBentley self-assigned this Aug 26, 2024

mayank99 linked an issue Aug 26, 2024 that may be closed by this pull request

Update outdated package.json fields and README.md #957

Open

Merge branch 'master' into MBudrevicius/UpdateDocumentation

c03c4d6

GerardasB requested changes Sep 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated Git documentation. #983

Updated Git documentation. #983

MBudreviciusBentley commented Aug 26, 2024

CLAassistant commented Aug 26, 2024 •

edited

Loading

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024 •

edited

Loading

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024

GerardasB Sep 3, 2024


		See the [iTwin.js](https://www.itwinjs.org/learning/ui/core/) documentation for more information.
		To get started with React components from the `@itwin/core-react` package, simply import the necessary components and utilities:

	To get started with React components from the `@itwin/core-react` package, simply import the necessary components and utilities:
	To get started with the `@itwin/components-react` package, simply import the necessary components and utilities:

	To get started with React components from the `@itwin/imodel-components-react` package, simply import the necessary components and utilities:
	To get started with the `@itwin/imodel-components-react` package, simply import the necessary components and utilities:

	For more details, check out the [@itwin/imodel-components-react](https://www.itwinjs.org/reference/imodel-components-react/).
	For more details, check out the [@itwin/imodel-components-react documentation](https://www.itwinjs.org/reference/imodel-components-react/).

	"description": "A react component library for iTwin.js UI IModel Components",
	"description": "A react component library of iTwin.js UI iModel components",

	For more details, check out the [@itwin/appui-react documentation](https://www.itwinjs.org/reference/appui-react/).
	For more details, check out [Get Started](https://www.itwinjs.org/ui/appui/get-started/) guide or [@itwin/appui-react documentation](https://www.itwinjs.org/reference/appui-react/).

Updated Git documentation. #983

Are you sure you want to change the base?

Updated Git documentation. #983

Conversation

MBudreviciusBentley commented Aug 26, 2024

Changes

Testing

CLAassistant commented Aug 26, 2024 • edited Loading

Choose a reason for hiding this comment

GerardasB Sep 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Aug 26, 2024 •

edited

Loading

GerardasB Sep 3, 2024 •

edited

Loading