Foundation-sites: Foundation Sites 6 Typescript Definition File

[stcp]

Hi all,

It's new on Foundation Sites and first time on github. I have made some modifications on typescript definition file "foundation.d.ts" and not sure here is the right place to post it. Attached is the file and hope someone just may find it useful.

Regards,

Steven
foundation-sites-6.d.zip

[ncoden]

Hi @stcp. Welcome to Github ! 🎉

I would advise you to create a Pull Request for Foundation.

To help you, here some guides that show how to contribute to Github projects:

• https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ (a very complete guide)
• http://kbroman.org/github_tutorial/pages/fork.html (more concise)
• https://guides.github.com/activities/contributing-to-open-source/ (official guide)

After you made a pull request, Foundation maintainers will review it to ensure that everything is okay, then merge your changes.

Please feel free to ask if you need help or have any question ! :)

Nicolas

[IamManchanda]

Thanks buddy for these links. It really helped Nicolas bro

@stcp : Go for the first link if you confused within choosing !

[stcp]

Thanks Nicolas and IamManchanda, I will try later on :)

[IamManchanda]

Heartly welcome bro ,,,,, Foundation Community and yetinauts are always there for help.

[DaSchTour]

I've taken a short look on the definitions and I cant't really determine what was changed, because everything is changed so I can't see any improvement. Maybe you describe what your improvement is about.

[stcp]

Hi DaSchTour,

I have added some Foundation global settings, for example:

Foundation.Abide.defaults.patterns,
Foundation.Abide.defaults.validators

The original definition file wont allow me to to that. May be there is a simpler way to do it using the original but due to my limited knowledge that is the best I can do.

Regards,

Steven

[stcp]

I am writing some angular2 directives for Foundation Sites 6 just for learning both, after polish and cleanup the codes, I may submit to the github....

[DaSchTour]

Nice to hear. Would love to see the work on angular2. In the meantime I added Abide defaults to typings ;)
Maybe you could download the updated typings from my work an verify that it works as you expected.

[IamManchanda]

@DaSchTour can you help me on this https://github.com/zurb/foundation-sites/issues/9592#issuecomment-270592836 ?
Asking this as you just merged zurb:develop

{{ Sorry for refrencing an unrelated issue }}

[stcp]

Hi DaSchTour,

Thanks for the updated definition file.

Would it be better if variables defined within interface FoundationSitesStatic have their own factory interfaces so that extending the type definitions would be easier, just a thought.

Regards,

Steven

---

For example:

declare module FoundationSites{
    interface Abide{
        findRadioLabels(element:JQuery):any;
    }
    interface InterchangeFactory{  
        SPECIAL_QUERIES?:{[key:string]:string};
    }

}

[DaSchTour]

@stcp I would like to keep Definitions as simple as possible and not introducing additional interfaces that have not representation in JS code.

[stcp]

Defining of a variable in FoundationSites as an interface is the same as the existing, but allow one to add types without modifying the original....

 Abide: {
      new(element: JQuery, options?: IAbideOptions): Abide;
      defaults: AbideDefaults;
 }

instead

interface AbideFactory{
       new(element: JQuery, options?: IAbideOptions): Abide&JQuery;

  }
Abide: AbideFactory;

If some types are missing from the installed Foundation version at the time of development, one can just add the types by defining the interface again with new types in a separate file.

say

declare module FoundationSites{
  interface AbideFactory {
        defaults?:{           
            validators?:{[key:string]:Function};
            patterns?:{[key:string]:RegExp}; 
        };
    }
}

[DaSchTour]

There shouldn't be any typings missing, that's the goal ;)
So let's make the typings include everything that is available in JS.

[kball]

Closing this based on the discussion in #9616