Skip to content
This repository was archived by the owner on Aug 7, 2020. It is now read-only.
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: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AxelPeter @FredericEspiau @euhmeuh @JeremyDec
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [github@ovh.net](mailto:github@ovh.net). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
### Description

<!-- Required -->
<!-- Description of the issue -->

### Steps to reproduce

<!-- Required -->
1. [First Step]
2. [Second Step]
3. [and so on...]

**Expected behavior**:

<!-- What did you expect to happen -->

**Actual behavior**:

<!-- What actually happens -->

**Frequency**:
<!-- How often does the issue happen, on a scale from 1 (rare) to 5 (always)?-->

### Additional information
<!-- optional -->
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue -->
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
### Requirements

* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* All new code requires tests to ensure against regressions

## Title of the Pull Requests <!-- required -->


### Description of the Change

<!-- required -->
<!-- Can be a listing of commit descriptions -->

### Benefits

<!-- optional -->
<!-- What benefits will be achieved by the code change? -->

### Possible Drawbacks

<!-- optional -->
<!-- What are the possible side-effects or negative impacts of the code change? -->

### Applicable Issues

<!-- optional -->
<!-- Enter any applicable Issues here -->
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# OVH UI Kit (AngularJS)

![OVH component](https://user-images.githubusercontent.com/3379410/27423240-3f944bc4-5731-11e7-87bb-3ff603aff8a7.png)

A set of maintainable components for the OVH ecosystem (AngularJS).

[![NPM](https://nodei.co/npm/ovh-ui-angular.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/ovh-ui-angular/)

![Project status stable](https://img.shields.io/badge/status-stable-blue.svg)
[![Maintenance](https://img.shields.io/maintenance/yes/2018.svg)]()
[![Chat on gitter](https://img.shields.io/gitter/room/ovh/ux.svg)](https://gitter.im/ovh/ux)

# OVH UI (Angular)

A set of maintainable components for the OVH ecosystem (Angular).

## Installation

### Prerequisites
Expand All @@ -23,25 +25,31 @@ You will also need these dependencies in your project:

Follow the [guide](https://github.com/ovh-ux/ovh-ui-kit) for _ovh-ui-kit_, because you need to integrate it by _yourself_.

### bower
### Install with [npm](https://www.npmjs.com/)

```bash
bower install --save ovh-ui-angular
npm install ovh-ui-angular
```

### npm
### Install with [yarn](https://yarnpkg.com)

```bash
npm install --save ovh-ui-angular
yarn add ovh-ui-angular
```

### Install with [bower](https://bower.io/) (deprecated)

```bash
bower install --save ovh-ui-angular
```

## Usage

1. In your `index.html`, you need to load `oui-angular.js`:
1. In your `index.html`, you need to load `oui-angular.min.js`:

```html
...
<script src="ovh-ui-angular/packages/oui-angular/dist/oui-angular.js" type="text/javascript"></script>
<script src="ovh-ui-angular/dist/oui-angular.min.js" type="text/javascript"></script>
...
```

Expand Down
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@
}
},
"dependencies": {
"clipboard": "2.0.1",
"angular": "~1.6.1",
"angular-aria": "~1.6.1",
"angular-sanitize": "~1.6.1",
"clipboard": "^2.0.1",
Copy link
Contributor

Choose a reason for hiding this comment

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

Sometimes you use carets and sometimes tildes, is there any reason ?

Copy link
Contributor Author

@AxelPeter AxelPeter Aug 3, 2018

Choose a reason for hiding this comment

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

It depends what we want for our dependencies:

  • ~ -> Get only patches
  • ^ -> Get minors and patches

Copy link
Contributor

Choose a reason for hiding this comment

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

I know that, what I don't know is, how do you decide what dependencies should have the patches, and what dependencies should have minor updates ? Why don't you take minor updates for Angular for example ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Like we do for our managers :)
Because it's only tested now for angular 1.6.x, and we don't want to update for 1.7.x

"escape-string-regexp": "^1.0.5",
"flatpickr": "4.5.0",
"flatpickr": "^4.5.1",
"popper.js": "^1.14.3"
},
"devDependencies": {
"angular": "~1.6.1",
"angular-aria": "~1.6.1",
"angular-mocks": "~1.6.1",
"angular-sanitize": "~1.6.1",
"autoprefixer": "^8.0.0",
"babel-cli": "^6.18.0",
"babel-core": "^6.21.0",
Expand All @@ -54,7 +54,6 @@
"babel-preset-env": "^1.6.1",
"babel-preset-stage-2": "^6.22.0",
"babel-register": "^6.18.0",
"bootstrap": "^3.3.7",
"cross-env": "^5.1.0",
"css-loader": "^0.28.4",
"eslint": "^4.3.0",
Expand Down
22 changes: 11 additions & 11 deletions packages/oui-action-menu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,19 @@

| Attribute | Type | Binding | One-time binding | Values | Default | Description
| ---- | ---- | ---- | ---- | ---- | ---- | ----
| `text` | string | @ | yes | | | button label
| `aria-label` | string | @? | yes | | | accessibility label
| `align` | string | @? | yes | `start`,`center`,`end` | `center` | menu alignment
| `compact` | boolean | <? | yes | | `false` | use the compact button
| `disabled` | boolean | <? | | | `false` | disable flag
| `text` | string | @ | yes | n/a | n/a | button label
| `aria-label` | string | @? | yes | n/a | n/a | accessibility label
| `align` | string | @? | yes | `start`, `center`, `end` | `center` | menu alignment
| `compact` | boolean | <? | yes | `true`, `false` | `false` | use the compact button
| `disabled` | boolean | <? | no | `true`, `false` | `false` | disable flag

### oui-action-menu-item

| Attribute | Type | Binding | One-time binding | Values | Default | Description
| ---- | ---- | ---- | ---- | ---- | ---- | ----
| `text` | string | @ | | | | button label
| `aria-label` | string | @? | | | | accessibility label
| `href` | string | @? | yes | | | hypertext link (link)
| `disabled` | boolean | <? | | | `false` | disable (button)
| `external` | boolean | @? | yes | | | display external icon (link)
| `on-click` | | &? | | | | on-click handler (button)
| `text` | string | @ | no | n/a | n/a | button label
| `aria-label` | string | @? | no | n/a | n/a | accessibility label
| `href` | string | @? | yes | n/a | n/a | hypertext link (link)
| `disabled` | boolean | <? | no | `true`, `false` | `false` | disable (button)
| `external` | boolean | @? | yes | `true`, `false` | `false` | display external icon (link)
| `on-click` | function | &? | no | n/a | n/a | on-click handler (button)
82 changes: 42 additions & 40 deletions packages/oui-angular/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,43 +37,45 @@ import Textarea from "@oui-angular/oui-textarea/src";
import Tile from "@oui-angular/oui-tile/src";
import Tooltip from "@oui-angular/oui-tooltip/src";

angular.module("oui", [
ActionMenu,
BackButton,
Button,
Calendar,
Checkbox,
Chips,
Clipboard,
Collapsible,
CriteriaAdder,
CriteriaContainer,
Datagrid,
Dropdown,
Field,
FormActions,
GuideMenu,
HeaderTabs,
Message,
Modal,
Navbar,
Numeric,
PageHeader,
Pagination,
Popover,
Progress,
Radio,
RadioGroup,
RadioToggleGroup,
Search,
Select,
SelectPicker,
Skeleton,
Slideshow,
Spinner,
Stepper,
Switch,
Textarea,
Tile,
Tooltip
]);
export default angular
.module("oui", [
ActionMenu,
BackButton,
Button,
Calendar,
Checkbox,
Chips,
Clipboard,
Collapsible,
CriteriaAdder,
CriteriaContainer,
Datagrid,
Dropdown,
Field,
FormActions,
GuideMenu,
HeaderTabs,
Message,
Modal,
Navbar,
Numeric,
PageHeader,
Pagination,
Popover,
Progress,
Radio,
RadioGroup,
RadioToggleGroup,
Search,
Select,
SelectPicker,
Skeleton,
Slideshow,
Spinner,
Stepper,
Switch,
Textarea,
Tile,
Tooltip
])
.name;
15 changes: 7 additions & 8 deletions packages/oui-back-button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,10 @@

| Attribute | Type | Binding | One-time binding | Values | Default | Description
| ---- | ---- | ---- | ---- | ---- | ---- | ----
| `id` | string | @? | true | | | id attribute of the input
| `name` | string | @? | true | | | name attribute of the input
| `aria-label` | string | @? | true | | | accessibility label
| `heading` | string | @? | true | | | text of the header
| `on-click` | function | &? | | | | callback on component click
| `href` | string | @? | true | | | url of the return link
| `state` | string | @? | yes | | | state of the return link
| `stateParams` | object | <? | | | | state params of the return link
| `id` | string | @? | yes | n/a | n/a | id attribute of the button/link
| `name` | string | @? | yes | n/a | n/a | name attribute of the button/link
| `aria-label` | string | @? | yes | n/a | n/a | accessibility label of the button/link
| `href` | string | @? | yes | n/a | n/a | url of the return link
| `state` | string | @? | yes | n/a | n/a | state of the return link
| `stateParams` | object | <? | no | n/a | n/a | state params of the return link
| `on-click` | function | &? | no | n/a | n/a | callback on component click
8 changes: 4 additions & 4 deletions packages/oui-back-button/src/back-button.component.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ export default {
bindings: {
id: "@?",
name: "@?",
heading: "@?", // Deprecated: Replaced by transclude value
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

Choose a reason for hiding this comment

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

Don't you keep the deprecated parameters in the documentation for a while ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why not, we could do it for notifying that it will become deprecated

title: "@?", // Deprecated: Replaced by transclude value
ariaLabel: "@?",
heading: "@?",
title: "@?", // Deprecated: Replaced by 'heading'
onClick: "&?",
href: "@?",
state: "@?",
stateParams: "<?"
stateParams: "<?",
onClick: "&?"
},
transclude: true
};
Loading